@candulabs/core - npm Package Compare versions

Comparing version 0.8.0-alpha.16 to 0.8.0-alpha.17

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+# 0.8.0-alpha.17 (2021-07-26)
+
+**Note:** Version bump only for package @candulabs/core
+
+
+
+
+
 # 0.8.0-alpha.16 (2021-07-21)
@@ -8,0 +16,0 @@

dist/contexts/CanduTutorialDocumentContextType.d.ts

@@ -1,6 +0,6 @@
-import { TutorialId } from '../models';
+import { Id } from '../models';
 import { TutorialDependencies } from '../document/TutorialDependencies';
 export declare type CanduTutorialDocumentContextType = {
-    id: TutorialId;
+    id: Id;
     dependencies: TutorialDependencies;
 };

dist/document/tutorialDocumentContext.d.ts

 import { CanduTutorialDocumentContextType } from '../contexts';
-import { TutorialId } from '../models';
-export declare const createTutorialDocumentContext: (id: TutorialId, parentContext: CanduTutorialDocumentContextType | null) => CanduTutorialDocumentContextType;
-export declare const checkCyclicAndAdd: (context: CanduTutorialDocumentContextType, tutorialId: TutorialId) => boolean;
+import { Id } from '../models';
+export declare const createTutorialDocumentContext: (id: Id, parentContext: CanduTutorialDocumentContextType | null) => CanduTutorialDocumentContextType;
+export declare const checkCyclicAndAdd: (context: CanduTutorialDocumentContextType, tutorialId: Id) => boolean;

dist/inputValidation/inputValidation.d.ts

 import { Eventing } from '@candulabs/eventing';
-import { CanduClientOptions, ClientToken, ContentHashId, PortalSlug, TrackingIdentifiers, TutorialDocumentType, TutorialId, TutorialSlug, UserId } from '../models';
+import { CanduClientOptions, ClientToken, ContentHashId, PortalSlug, TrackingIdentifiers, UserId, DocumentDefinitionType, Id } from '../models';
 export interface ProviderProps {
@@ -32,5 +32,5 @@ /** The client token associated with the application we want to render */
     /** @hidden Render a specific tutorial id from the API. Useful for testing purposes. */
-    tutorialId?: TutorialId;
-    /** @hidden Render a specific tutorial document, useful for debugging */
-    tutorialDocument?: TutorialDocumentType;
+    tutorialId?: Id;
+    /** @hidden Render a specific document definition, useful for debugging */
+    documentDefinition?: DocumentDefinitionType;
     /** @hidden specifies whether the render was triggered by a client */
@@ -40,3 +40,3 @@ renderedByClient?: boolean;
 }
-export declare const tutorialValidation: <T extends TutorialProps>({ slug, styleguide, contentHashId, tutorialId, tutorialDocument, renderedByClient, ...otherProps }: T) => Omit<T, "styleguide" | "slug" | "contentHashId" | "tutorialId" | "tutorialDocument" | "renderedByClient"> & {
+export declare const tutorialValidation: <T extends TutorialProps>({ slug, styleguide, contentHashId, tutorialId, documentDefinition, renderedByClient, ...otherProps }: T) => Omit<T, "styleguide" | "slug" | "contentHashId" | "tutorialId" | "documentDefinition" | "renderedByClient"> & {
     slug: string | undefined;
@@ -46,3 +46,3 @@ styleguide: object;
     tutorialId: number | undefined;
-    tutorialDocument: TutorialDocumentType | undefined;
+    documentDefinition: DocumentDefinitionType | undefined;
     renderedByClient: boolean | undefined;
@@ -55,2 +55,3 @@ };
     renderedByClient?: boolean;
+    trackingIdentifiers?: TrackingIdentifiers;
 }
@@ -65,5 +66,5 @@ export interface ContentProps {
     /** @hidden Render a specific tutorial id from the API. Useful for testing purposes. */
-    tutorialId?: TutorialId;
-    /** @hidden Render a specific tutorial document, useful for debugging */
-    tutorialDocument?: TutorialDocumentType;
+    tutorialId?: Id;
+    /** @hidden Render a specific documentDefinition, useful for debugging */
+    documentDefinition?: DocumentDefinitionType;
     /** @hidden specifies whether the render was triggered by a client */
@@ -81,6 +82,6 @@ renderedByClient?: boolean;
 };
-export interface TutorialDocumentProps {
-    tutorialDocument: TutorialDocumentType;
+export interface DocumentDefinitionProps {
+    documentDefinition: DocumentDefinitionType;
     trackingIdentifiers?: TrackingIdentifiers;
     slug?: string;
 }

dist/models/eventing/TrackingIdentifiers.d.ts

@@ -1,10 +0,10 @@
-import { PortalId, PortalSlug } from '../notebook/Portal';
 import { SegmentId } from './Segment';
-import { TutorialId } from '../notebook/TutorialDocument';
+import { Id } from '../notebook/DocumentDefinition';
+import { CommitId } from '../notebook';
 export interface TrackingIdentifiers {
-    tutorialId: TutorialId;
+    id?: Id;
+    versionId?: CommitId;
     segmentId?: SegmentId;
-    portalId?: PortalId;
-    portalSlug?: PortalSlug;
+    segmentIds?: string[];
     parentTrackers?: Array<TrackingIdentifiers>;
 }

dist/models/notebook/index.d.ts

@@ -6,3 +6,3 @@ export * from './Actions';
 export * from './Portal';
-export * from './TutorialDocument';
+export * from './DocumentDefinition';
 export * from './TutorialMetadata';
@@ -9,0 +9,0 @@ export * from './NodeData';

dist/models/notebook/Portal.d.ts

 import { SegmentId } from '../eventing/Segment';
 import { ContentHashId, TutorialTreeHashId } from './Hashes';
-import { TutorialId } from './TutorialDocument';
+import { Id } from './DocumentDefinition';
 export declare type PortalId = number;
@@ -9,3 +9,3 @@ export declare type PortalSlug = string;
     segmentId: SegmentId;
-    tutorialId: TutorialId;
+    tutorialId: Id;
     tutorialVersionId: TutorialTreeHashId;
@@ -12,0 +12,0 @@ }

dist/models/notebook/TutorialMetadata.d.ts

@@ -1,4 +0,4 @@
-import { TutorialId, TutorialSlug } from './TutorialDocument';
+import { Id, Slug } from './DocumentDefinition';
 export interface TutorialMetadata {
-    id: TutorialId;
+    id: Id;
     documentId: number;
@@ -10,5 +10,5 @@ lastModifiedAt: string;
     publishedState: string;
-    slug: TutorialSlug;
+    slug: Slug;
     name: string;
     folderId?: number;
 }

dist/models/sdk/preview.d.ts

 import { SegmentId } from '../eventing';
-import { TutorialId } from '../notebook';
+import { Id } from '../notebook';
 export declare const PREVIEW_COOKIE_NAME = "candu.preview";
@@ -17,3 +17,3 @@ export declare const PREVIEW_URL_PARAM = "candu_preview";
 export interface PreviewContent {
-    tutorialId?: TutorialId;
+    tutorialId?: Id;
     segmentId?: SegmentId;
@@ -20,0 +20,0 @@ }

dist/networking/endpoints.d.ts

@@ -1,2 +0,2 @@
-import { ApiError, ClientToken, TutorialDocumentType } from '../models';
+import { ApiError, ClientToken, DocumentDefinitionType } from '../models';
 export declare const fetchURL: (url: string, headers?: any) => Promise<any>;
@@ -6,5 +6,5 @@ export declare const fetchFromApi: (endpoint: string) => Promise<any>;
 export declare const getTutorialDocument: (clientToken: ClientToken) => {
-    byId: (tutorialId: number) => Promise<TutorialDocumentType | ApiError>;
-    bySlug: (slug: string) => Promise<TutorialDocumentType | ApiError>;
-    byContentHash: (contentHashId: string) => Promise<TutorialDocumentType | ApiError>;
+    byId: (tutorialId: number) => Promise<DocumentDefinitionType | ApiError>;
+    bySlug: (slug: string) => Promise<DocumentDefinitionType | ApiError>;
+    byContentHash: (contentHashId: string) => Promise<DocumentDefinitionType | ApiError>;
 };

dist/networking/resources.d.ts

 import { Eventing } from '@candulabs/eventing';
-import { ClientToken, TutorialId, TutorialDocumentType, UserId, ContentDocument, ApiError, PortalAsset } from '../models';
+import { ClientToken, Id, DocumentDefinitionType, UserId, ContentDocument, ApiError, PortalAsset } from '../models';
 import { TutorialProps } from '../inputValidation';
 export declare const RESOURCES: {
-    tutorialDocumentLatestSaved: (clientToken: ClientToken, tutorialId: TutorialId) => Promise<any>;
-    portalAsset: (clientToken: ClientToken, slug: string, segmentIds: string[]) => Promise<TutorialDocumentType | PortalAsset | ApiError | null>;
+    tutorialDocumentLatestSaved: (clientToken: ClientToken, tutorialId: Id) => Promise<any>;
+    portalAsset: (clientToken: ClientToken, slug: string, segmentIds: string[]) => Promise<DocumentDefinitionType | PortalAsset | ApiError | null>;
     contentDocument: (clientToken: ClientToken, slug: string, segmentIds?: string[] | undefined) => Promise<ContentDocument | ApiError | null>;
@@ -12,3 +12,3 @@ segmentMembership: (clientToken: ClientToken, userId: UserId) => Promise<any>;
     /** composite methods */
-    tutorialDocument: (tutorialProps: TutorialProps, clientToken: ClientToken, eventing: Eventing) => Promise<TutorialDocumentType | ApiError> | null;
+    tutorialDocument: (tutorialProps: TutorialProps, clientToken: ClientToken, eventing: Eventing) => Promise<DocumentDefinitionType | ApiError> | null;
 };

dist/preact/Content/Content.d.ts

 import React from 'preact/compat';
 import { ContentProps } from '../../inputValidation';
-import { TutorialDocumentType } from '../../models';
+import { DocumentDefinitionType } from '../../models';
 interface RenderContentProps extends ContentProps {
-    tutorialDocument: TutorialDocumentType;
+    documentDefinition: DocumentDefinitionType;
 }
-export declare const RenderContent: ({ tutorialDocument, slug }: RenderContentProps) => React.JSX.Element | null;
+export declare const RenderContent: ({ documentDefinition, slug, trackingIdentifiers, }: RenderContentProps) => React.JSX.Element | null;
 export declare const Content: (props: ContentProps) => React.JSX.Element;
 export {};

dist/preact/index.d.ts

 export { CanduProvider, CanduProviderProps, defaultProviderContext } from './CanduProvider';
-export { TutorialDocument } from './TutorialDocument';
+export { DocumentDefinition as TutorialDocument, DocumentDefinition } from './DocumentDefinition';
 export { Content } from './Content';
 export { ErrorBoundary } from './ErrorBoundary';
 export { useEventing } from './hooks';

dist/preact/types/PortalAsset.d.ts

@@ -1,5 +0,5 @@
-import { ContentHashId, PortalId, PortalSlug, SegmentId, TutorialTreeHashId, TutorialId } from '../../models';
+import { ContentHashId, PortalId, PortalSlug, SegmentId, TutorialTreeHashId, Id } from '../../models';
 export interface SegmentTutorialTree {
     segmentId: SegmentId;
-    tutorialId: TutorialId;
+    tutorialId: Id;
     tutorialVersionId: TutorialTreeHashId;
@@ -6,0 +6,0 @@ }

dist/styleguide/mapNodeToStyleguide.d.ts

@@ -1,2 +0,2 @@
-import { Document, TrackingIdentifiers } from '../models';
+import { TrackingIdentifiers, DocumentDefinitionType } from '../models';
 import { StyleguideComponent, StyleguideProps } from './types';
@@ -6,3 +6,3 @@ import { RootStore } from '../store';
 declare type Options = {
-    document: Document;
+    documentDefinition: DocumentDefinitionType;
     trackingIdentifiers: TrackingIdentifiers;
@@ -9,0 +9,0 @@ renderNode: (component: StyleguideComponent, props: StyleguideProps) => any;

dist/tutorial/initDocument.d.ts

 import { RootStore } from '../store';
-import { TutorialDocumentType } from '../models';
-export declare function initDocument(tutorialDocument: TutorialDocumentType, rootStore: RootStore): void;
+import { DocumentDefinitionType } from '../models';
+export declare function initDocument(tutorialDocument: DocumentDefinitionType, rootStore: RootStore): void;

dist/tutorial/stores/tutorialDocumentsFlux.d.ts

@@ -1,5 +0,5 @@
-import { TutorialDocumentType } from '../../models';
+import { DocumentDefinitionType } from '../../models';
 import { FetchState } from '../../store';
-declare type TutorialDocumentsState = Record<string, FetchState<TutorialDocumentType>>;
+declare type TutorialDocumentsState = Record<string, FetchState<DocumentDefinitionType>>;
 export declare const tutorialDocumentsFlux: import("../../store").Flux<TutorialDocumentsState>;
 export {};

package.json

@@ -12,3 +12,3 @@ {
   },
-  "version": "0.8.0-alpha.16",
+  "version": "0.8.0-alpha.17",
   "main": "dist/index.js",
@@ -30,3 +30,3 @@ "module": "dist/index.es.js",
   "dependencies": {
-    "@candulabs/eventing": "^0.8.0-alpha.16",
+    "@candulabs/eventing": "^0.8.0-alpha.17",
     "dataloader": "^2.0.0",
@@ -37,3 +37,3 @@ "preact": "10.5.13",
   },
-  "gitHead": "59db4e9a483a7d3d671e3ba616e4ef65b3458ff2"
+  "gitHead": "37d9913826d7b0bf17d3e43f70611fbd44ff4e4b"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

575373

increased by0.32%

Lines of code

3762

increased by0.21%

Dependency changes

• Updated@candulabs/eventing@^0.8.0-alpha.17