@collective-intelligence/extensions-sdk-frontend-react 0.1.8 → 0.1.10

package/dist/studio-api/types.gen.d.ts

@@ -0,0 +1,492 @@
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+export type EntityValueDiagnosticEncoded = {
+    _tag: "EntityValueDiagnostic";
+    code: "entity_value_invalid";
+    field: string;
+    issues: Array<{
+        field: string;
+        keyword: string;
+        message: string;
+        path: string;
+    }>;
+    message: string;
+};
+export type EntityFileFieldDiagnosticEncoded = {
+    _tag: "EntityFileFieldDiagnostic";
+    code: "file_field_invalid" | "file_too_large";
+    field: string;
+    message: string;
+    reason: "invalid_form" | "unknown_attachment" | "invalid_upload" | "upload_consumed" | "type_not_accepted" | "file_too_large" | "unknown_stored_file";
+};
+export type EntityRelationFieldDiagnosticEncoded = {
+    _tag: "EntityRelationFieldDiagnostic";
+    code: "relation_field_invalid";
+    field: string;
+    message: string;
+    reason: "invalid_value" | "duplicate_target" | "max_items_exceeded" | "target_not_found" | "wrong_target_schema" | "target_deleted" | "base_filter_mismatch";
+};
+export type EntityUniqueFieldConflictDiagnosticEncoded = {
+    _tag: "EntityUniqueFieldConflictDiagnostic";
+    code: "unique_field_conflict";
+    fields: Array<string>;
+    message: string;
+};
+export type EntityFileFieldConflictDiagnosticEncoded = {
+    _tag: "EntityFileFieldConflictDiagnostic";
+    code: "file_field_connector_owned";
+    message: string;
+};
+export type Suspend2 = null | boolean | number | string | Array<Suspend2> | {
+    [key: string]: Suspend2;
+};
+export type InvalidIncludePathEncoded = {
+    _tag: "InvalidIncludePath";
+    message: string;
+    path: string;
+    reason: "malformed" | "too_deep" | "unknown_field";
+};
+export type EffectHttpApiErrorBadRequestEncoded = {
+    _tag: "BadRequest";
+};
+export type EffectHttpApiErrorUnauthorizedEncoded = {
+    _tag: "Unauthorized";
+};
+export type EffectHttpApiErrorForbiddenEncoded = {
+    _tag: "Forbidden";
+};
+export type EffectHttpApiErrorNotFoundEncoded = {
+    _tag: "NotFound";
+};
+export type EffectHttpApiErrorInternalServerErrorEncoded = {
+    _tag: "InternalServerError";
+};
+export type StudioAgentRunsListData = {
+    body?: never;
+    headers: {
+        authorization?: string;
+        "x-organization-id": string;
+    };
+    path?: never;
+    query: {
+        appId: string;
+        pageId: string;
+        publishedRevisionId: string;
+        viewId: string;
+        agent?: string;
+        limit?: string;
+        page?: string;
+    };
+    url: "/studio/agent-runs";
+};
+export type StudioAgentRunsListErrors = {
+    /**
+     * BadRequest
+     */
+    400: EffectHttpApiErrorBadRequestEncoded;
+    /**
+     * Unauthorized
+     */
+    401: EffectHttpApiErrorUnauthorizedEncoded;
+    /**
+     * Forbidden
+     */
+    403: EffectHttpApiErrorForbiddenEncoded;
+    /**
+     * InternalServerError
+     */
+    500: EffectHttpApiErrorInternalServerErrorEncoded;
+};
+export type StudioAgentRunsListError = StudioAgentRunsListErrors[keyof StudioAgentRunsListErrors];
+export type StudioAgentRunsListResponses = {
+    /**
+     * Success
+     */
+    200: {
+        canManage: boolean;
+        data: Array<{
+            agentId: string;
+            agentName: string;
+            completedAt: string | null;
+            createdAt: string;
+            errorCode: string | null;
+            id: string;
+            initiator: {
+                kind: "user";
+                name: string | null;
+            } | null;
+            source: string;
+            startedAt: string | null;
+            status: string;
+        }>;
+        paging: {
+            page: number;
+            pageSize: number;
+            totalItems: number;
+            totalPages: number;
+        };
+    };
+};
+export type StudioAgentRunsListResponse = StudioAgentRunsListResponses[keyof StudioAgentRunsListResponses];
+export type StudioAgentRunsGetData = {
+    body?: never;
+    headers: {
+        authorization?: string;
+        "x-organization-id": string;
+    };
+    path: {
+        runId: string;
+    };
+    query: {
+        appId: string;
+        pageId: string;
+        publishedRevisionId: string;
+        viewId: string;
+    };
+    url: "/studio/agent-runs/{runId}";
+};
+export type StudioAgentRunsGetErrors = {
+    /**
+     * BadRequest
+     */
+    400: EffectHttpApiErrorBadRequestEncoded;
+    /**
+     * Unauthorized
+     */
+    401: EffectHttpApiErrorUnauthorizedEncoded;
+    /**
+     * Forbidden
+     */
+    403: EffectHttpApiErrorForbiddenEncoded;
+    /**
+     * NotFound
+     */
+    404: EffectHttpApiErrorNotFoundEncoded;
+    /**
+     * InternalServerError
+     */
+    500: EffectHttpApiErrorInternalServerErrorEncoded;
+};
+export type StudioAgentRunsGetError = StudioAgentRunsGetErrors[keyof StudioAgentRunsGetErrors];
+export type StudioAgentRunsGetResponses = {
+    /**
+     * Success
+     */
+    200: {
+        agentId: string;
+        agentName: string;
+        completedAt: string | null;
+        createdAt: string;
+        errorCode: string | null;
+        id: string;
+        initiator: {
+            kind: "user";
+            name: string | null;
+        } | null;
+        source: string;
+        startedAt: string | null;
+        status: string;
+    };
+};
+export type StudioAgentRunsGetResponse = StudioAgentRunsGetResponses[keyof StudioAgentRunsGetResponses];
+export type StudioViewDataSearchData = {
+    body: {
+        cursor?: string | null;
+        filters?: Array<{
+            caseSensitive?: boolean;
+            field: string;
+            operator: "eq" | "ne" | "in" | "nin" | "contains" | "not_contains" | "starts_with" | "ends_with" | "gt" | "gte" | "lt" | "lte" | "exists" | "is_empty" | "is_not_empty";
+            value: Suspend2 | Array<Suspend2>;
+        }>;
+        include?: Array<string>;
+        limit?: number;
+        sort?: Array<{
+            direction: "asc" | "desc";
+            field: string;
+        }>;
+        text?: string;
+    };
+    headers: {
+        authorization?: string;
+        "x-organization-id": string;
+    };
+    path: {
+        slug: string;
+        viewId: string;
+    };
+    query?: never;
+    url: "/studio/apps/by-slug/{slug}/views/{viewId}/data/search";
+};
+export type StudioViewDataSearchErrors = {
+    /**
+     * InvalidIncludePath | BadRequest
+     */
+    400: InvalidIncludePathEncoded | EffectHttpApiErrorBadRequestEncoded;
+    /**
+     * Unauthorized
+     */
+    401: EffectHttpApiErrorUnauthorizedEncoded;
+    /**
+     * Forbidden
+     */
+    403: EffectHttpApiErrorForbiddenEncoded;
+    /**
+     * NotFound
+     */
+    404: EffectHttpApiErrorNotFoundEncoded;
+    /**
+     * InternalServerError
+     */
+    500: EffectHttpApiErrorInternalServerErrorEncoded;
+};
+export type StudioViewDataSearchError = StudioViewDataSearchErrors[keyof StudioViewDataSearchErrors];
+export type StudioViewDataSearchResponses = {
+    /**
+     * Success
+     */
+    200: unknown;
+};
+export type StudioViewDataGetItemData = {
+    body?: never;
+    headers: {
+        authorization?: string;
+        "x-organization-id": string;
+    };
+    path: {
+        slug: string;
+        viewId: string;
+        instanceId: string;
+    };
+    query?: {
+        include?: string;
+    };
+    url: "/studio/apps/by-slug/{slug}/views/{viewId}/data/{instanceId}";
+};
+export type StudioViewDataGetItemErrors = {
+    /**
+     * InvalidIncludePath | BadRequest
+     */
+    400: InvalidIncludePathEncoded | EffectHttpApiErrorBadRequestEncoded;
+    /**
+     * Unauthorized
+     */
+    401: EffectHttpApiErrorUnauthorizedEncoded;
+    /**
+     * Forbidden
+     */
+    403: EffectHttpApiErrorForbiddenEncoded;
+    /**
+     * NotFound
+     */
+    404: EffectHttpApiErrorNotFoundEncoded;
+    /**
+     * InternalServerError
+     */
+    500: EffectHttpApiErrorInternalServerErrorEncoded;
+};
+export type StudioViewDataGetItemError = StudioViewDataGetItemErrors[keyof StudioViewDataGetItemErrors];
+export type StudioViewDataGetItemResponses = {
+    /**
+     * Success
+     */
+    200: unknown;
+};
+export type StudioViewDataUpdateItemData = {
+    body: {
+        data?: {
+            [key: string]: unknown;
+        } | null;
+        description?: string | null;
+        name?: string | null;
+    };
+    headers: {
+        authorization?: string;
+        "x-organization-id": string;
+        "x-idempotency-key"?: string;
+    };
+    path: {
+        slug: string;
+        viewId: string;
+        instanceId: string;
+    };
+    query?: never;
+    url: "/studio/apps/by-slug/{slug}/views/{viewId}/data/{instanceId}";
+};
+export type StudioViewDataUpdateItemErrors = {
+    /**
+     * EntityValueDiagnostic | EntityFileFieldDiagnostic | EntityRelationFieldDiagnostic | BadRequest
+     */
+    400: EntityValueDiagnosticEncoded | EntityFileFieldDiagnosticEncoded | EntityRelationFieldDiagnosticEncoded | EffectHttpApiErrorBadRequestEncoded;
+    /**
+     * Unauthorized
+     */
+    401: EffectHttpApiErrorUnauthorizedEncoded;
+    /**
+     * Forbidden
+     */
+    403: EffectHttpApiErrorForbiddenEncoded;
+    /**
+     * NotFound
+     */
+    404: EffectHttpApiErrorNotFoundEncoded;
+    /**
+     * EntityUniqueFieldConflictDiagnostic | EntityFileFieldConflictDiagnostic
+     */
+    409: EntityUniqueFieldConflictDiagnosticEncoded | EntityFileFieldConflictDiagnosticEncoded;
+    /**
+     * InternalServerError
+     */
+    500: EffectHttpApiErrorInternalServerErrorEncoded;
+};
+export type StudioViewDataUpdateItemError = StudioViewDataUpdateItemErrors[keyof StudioViewDataUpdateItemErrors];
+export type StudioViewDataUpdateItemResponses = {
+    /**
+     * Success
+     */
+    200: {
+        data: unknown;
+    };
+};
+export type StudioViewDataUpdateItemResponse = StudioViewDataUpdateItemResponses[keyof StudioViewDataUpdateItemResponses];
+export type StudioWorkflowRunsListData = {
+    body?: never;
+    headers: {
+        authorization?: string;
+        "x-organization-id": string;
+    };
+    path?: never;
+    query: {
+        appId: string;
+        pageId: string;
+        publishedRevisionId: string;
+        viewId: string;
+        limit?: string;
+        page?: string;
+        workflow?: string;
+    };
+    url: "/studio/workflow-runs";
+};
+export type StudioWorkflowRunsListErrors = {
+    /**
+     * BadRequest
+     */
+    400: EffectHttpApiErrorBadRequestEncoded;
+    /**
+     * Unauthorized
+     */
+    401: EffectHttpApiErrorUnauthorizedEncoded;
+    /**
+     * Forbidden
+     */
+    403: EffectHttpApiErrorForbiddenEncoded;
+    /**
+     * InternalServerError
+     */
+    500: EffectHttpApiErrorInternalServerErrorEncoded;
+};
+export type StudioWorkflowRunsListError = StudioWorkflowRunsListErrors[keyof StudioWorkflowRunsListErrors];
+export type StudioWorkflowRunsListResponses = {
+    /**
+     * Success
+     */
+    200: {
+        canManage: boolean;
+        data: Array<{
+            completedAt: string | null;
+            createdAt: string;
+            errorCode: string | null;
+            id: string;
+            initiator: {
+                kind: "user";
+                name: string | null;
+            } | {
+                kind: "application";
+                name: string;
+            } | null;
+            startedAt: string | null;
+            status: string;
+            triggerType: string;
+            workflowId: string;
+            workflowName: string;
+        }>;
+        paging: {
+            page: number;
+            pageSize: number;
+            totalItems: number;
+            totalPages: number;
+        };
+    };
+};
+export type StudioWorkflowRunsListResponse = StudioWorkflowRunsListResponses[keyof StudioWorkflowRunsListResponses];
+export type StudioWorkflowRunsGetData = {
+    body?: never;
+    headers: {
+        authorization?: string;
+        "x-organization-id": string;
+    };
+    path: {
+        runId: string;
+    };
+    query: {
+        appId: string;
+        pageId: string;
+        publishedRevisionId: string;
+        viewId: string;
+    };
+    url: "/studio/workflow-runs/{runId}";
+};
+export type StudioWorkflowRunsGetErrors = {
+    /**
+     * BadRequest
+     */
+    400: EffectHttpApiErrorBadRequestEncoded;
+    /**
+     * Unauthorized
+     */
+    401: EffectHttpApiErrorUnauthorizedEncoded;
+    /**
+     * Forbidden
+     */
+    403: EffectHttpApiErrorForbiddenEncoded;
+    /**
+     * NotFound
+     */
+    404: EffectHttpApiErrorNotFoundEncoded;
+    /**
+     * InternalServerError
+     */
+    500: EffectHttpApiErrorInternalServerErrorEncoded;
+};
+export type StudioWorkflowRunsGetError = StudioWorkflowRunsGetErrors[keyof StudioWorkflowRunsGetErrors];
+export type StudioWorkflowRunsGetResponses = {
+    /**
+     * Success
+     */
+    200: {
+        completedAt: string | null;
+        createdAt: string;
+        errorCode: string | null;
+        id: string;
+        initiator: {
+            kind: "user";
+            name: string | null;
+        } | {
+            kind: "application";
+            name: string;
+        } | null;
+        startedAt: string | null;
+        status: string;
+        triggerType: string;
+        workflowId: string;
+        workflowName: string;
+        steps: Array<{
+            attempt: number;
+            completedAt: string | null;
+            nodeId: string;
+            startedAt: string | null;
+            status: string;
+        }>;
+    };
+};
+export type StudioWorkflowRunsGetResponse = StudioWorkflowRunsGetResponses[keyof StudioWorkflowRunsGetResponses];

package/dist/studio-declarations.d.ts

@@ -3,37 +3,6 @@ export type LocalizedStudioText = Readonly<{
     fallbackLocale: string;
     values: Readonly<Record<string, string>>;
 }>;
-export type StudioAppPageDefinition = Readonly<{
-    fullWidth?: boolean;
-    icon?: string;
-    kind: "predefined";
-    label: string;
-    orderIndex: number;
-    predefinedPageRef: string;
-    routeSegment: string;
-    slug: string;
-}>;
-export type StudioAppSectionDefinition = Readonly<{
-    description?: string;
-    icon?: string;
-    label: string;
-    orderIndex: number;
-    pages: readonly StudioAppPageDefinition[];
-    slug: string;
-}>;
-export type StudioAppDefinition = Readonly<{
-    color?: string;
-    description?: string;
-    icon?: string;
-    isDefaultTemplate?: boolean;
-    name: string;
-    sections: readonly StudioAppSectionDefinition[];
-    slug: string;
-}>;
-export type StudioAppDeclaration = ComponentManifest & ComponentPresentation & Readonly<{
-    definition: StudioAppDefinition;
-    kind: "studioApp";
-}>;
 export type StudioComponentComposition = Readonly<{
     extensions?: JsonObject;
     slotSource: "props" | "static";
@@ -50,13 +19,6 @@ export type StudioComponentDeclaration = ComponentManifest & ComponentPresentati
     propsSchema: PackageSchemaProjection;
     sourceRef: string;
 }>;
-export type StudioAppDeclarationInput = Readonly<{
-    definition: Readonly<{
-        definition: StudioAppDefinition;
-    }>;
-    manifest: ComponentManifest;
-    presentation: ComponentPresentation;
-}>;
 export type StudioComponentDeclarationInput<Schema extends PackageDecoderSource = PackageDecoderSource> = Readonly<{
     definition: Readonly<{
         category: StudioComponentDeclaration["category"];
@@ -67,5 +29,4 @@ export type StudioComponentDeclarationInput<Schema extends PackageDecoderSource
     manifest: ComponentManifest;
     presentation: ComponentPresentation;
 }>;
-export declare const declareStudioApp: (input: StudioAppDeclarationInput) => DeclaredComponent<StudioAppDeclaration>;
 export declare const declareStudioComponent: (input: StudioComponentDeclarationInput) => DeclaredComponent<StudioComponentDeclaration>;

package/dist/studio-view-context.d.ts

@@ -0,0 +1,45 @@
+/**
+ * The Studio Host's scope of one placed view. View, page, and revision ids
+ * are generated when an app is installed or published, so a Widget reads
+ * them here instead of declaring them.
+ */
+export type StudioViewContext = Readonly<{
+    appId: string;
+    appSlug: string;
+    organizationId: string;
+    pageId: string;
+    publishedRevisionId: string;
+    viewId: string;
+}>;
+/**
+ * Props the Studio Host gives every placed view and Widget component, next to
+ * its configured props. `context` is `null` when the view has no published
+ * scope: in the builder preview, or before the app has a published revision.
+ */
+export type StudioViewComponentProps = Readonly<{
+    context: StudioViewContext | null;
+}>;
+/** Generated `studio-api` options for the view-data operations of a view. */
+export type StudioViewScope = Readonly<{
+    headers: Readonly<{
+        "x-organization-id": string;
+    }>;
+    path: Readonly<{
+        slug: string;
+        viewId: string;
+    }>;
+}>;
+/** Generated `studio-api` options for operations on a published view. */
+export type StudioPublishedViewScope = Readonly<{
+    headers: Readonly<{
+        "x-organization-id": string;
+    }>;
+    query: Readonly<{
+        appId: string;
+        pageId: string;
+        publishedRevisionId: string;
+        viewId: string;
+    }>;
+}>;
+export declare const studioViewScope: (context: StudioViewContext) => StudioViewScope;
+export declare const studioPublishedViewScope: (context: StudioViewContext) => StudioPublishedViewScope;

package/dist/studio.d.ts

@@ -1,5 +1,23 @@
-import { declareStudioApp as declareStudioAppImplementation, declareStudioComponent as declareStudioComponentImplementation } from "./studio-declarations.js";
-export declare const declareStudioApp: typeof declareStudioAppImplementation;
+import { declareStudioComponent as declareStudioComponentImplementation } from "./studio-declarations.js";
+import { studioPublishedViewScope as studioPublishedViewScopeImplementation, studioViewScope as studioViewScopeImplementation } from "./studio-view-context.js";
+export declare const declareStudioApp: (input: import("@collective-intelligence/extensions-sdk").StudioAppDeclarationInput) => import("@collective-intelligence/extensions-sdk").DeclaredComponent<import("@collective-intelligence/extensions-sdk").StudioAppDeclaration>;
+export declare const declareStudioAppTemplate: (input: Readonly<{
+    definition: Omit<import("@collective-intelligence/extensions-sdk").StudioAppTemplateDeclaration, "description" | "displayName" | "fqn" | "icon" | "kind" | "tags" | "version">;
+    manifest: Readonly<{
+        fqn: string;
+        version: string;
+    }>;
+    presentation: Readonly<{
+        description?: string;
+        displayName: string;
+        icon?: string;
+        tags?: readonly string[];
+    }>;
+}>) => import("@collective-intelligence/extensions-sdk").DeclaredComponent<import("@collective-intelligence/extensions-sdk").StudioAppTemplateDeclaration>;
 export declare const declareStudioComponent: typeof declareStudioComponentImplementation;
+export declare const studioPublishedViewScope: typeof studioPublishedViewScopeImplementation;
+export declare const studioViewScope: typeof studioViewScopeImplementation;
 export type { HostedContributionErrorBoundaryProps, HostedContributionLoadFailure, HostedContributionLoadState, HostedContributionUnavailableProps } from "./load-state.js";
-export type { LocalizedStudioText, StudioAppDeclaration, StudioAppDeclarationInput, StudioAppDefinition, StudioAppPageDefinition, StudioAppSectionDefinition, StudioComponentComposition, StudioComponentDeclaration, StudioComponentDeclarationInput } from "./studio-declarations.js";
+export type { StudioAppDeclaration, StudioAppDeclarationInput, StudioAppDefinition, StudioAppPageDefinition, StudioAppSectionDefinition, StudioAppTemplateDeclaration, StudioAppTemplateDefinition, StudioAppTemplatePageDefinition, StudioAppTemplateSectionDefinition } from "@collective-intelligence/extensions-sdk";
+export type { LocalizedStudioText, StudioComponentComposition, StudioComponentDeclaration, StudioComponentDeclarationInput } from "./studio-declarations.js";
+export type { StudioPublishedViewScope, StudioViewComponentProps, StudioViewContext, StudioViewScope } from "./studio-view-context.js";

package/dist/studio.js

@@ -1 +1 @@
-import{assertConsumerProfile as s,canonicalJson as d,normalizePackageSchemaProjection as c}from"@collective-intelligence/extensions-sdk";var a=(o)=>{try{d(o)}catch(e){let t=e instanceof Error?e.message:String(e);throw TypeError(`Studio declaration must be serializable JSON: ${t}`,{cause:e})}},r=(o)=>{let e={...o.definition,...o.presentation,...o.manifest,kind:"studioApp"};return a(e),{manifest:e,schemaSidecars:[]}},p=(o)=>{let e=o.definition.propsSchema,t=`studio_component:${o.manifest.fqn}.propsSchema`,n=c(e.project("input"));s(n,"studio_props",t);let i={category:o.definition.category,...o.definition.composition===void 0?void 0:{composition:o.definition.composition},...o.presentation,...o.manifest,kind:"studioComponent",propsSchema:n,sourceRef:o.definition.sourceRef};return a(i),{manifest:i,schemaSidecars:[{direction:"input",location:t,profile:"studio_props",source:e}]}};var f=r,g=p;export{f as declareStudioApp,g as declareStudioComponent};
+import{declareStudioApp as l,declareStudioAppTemplate as m}from"@collective-intelligence/extensions-sdk";import{assertConsumerProfile as r,canonicalJson as s,normalizePackageSchemaProjection as c}from"@collective-intelligence/extensions-sdk";var u=(e)=>{try{s(e)}catch(o){let t=o instanceof Error?o.message:String(o);throw TypeError(`Studio declaration must be serializable JSON: ${t}`,{cause:o})}},a=(e)=>{let o=e.definition.propsSchema,t=`studio_component:${e.manifest.fqn}.propsSchema`,i=c(o.project("input"));r(i,"studio_props",t);let n={category:e.definition.category,...e.definition.composition===void 0?void 0:{composition:e.definition.composition},...e.presentation,...e.manifest,kind:"studioComponent",propsSchema:i,sourceRef:e.definition.sourceRef};return u(n),{manifest:n,schemaSidecars:[{direction:"input",location:t,profile:"studio_props",source:o}]}};var p=(e)=>({headers:{"x-organization-id":e.organizationId},path:{slug:e.appSlug,viewId:e.viewId}}),d=(e)=>({headers:{"x-organization-id":e.organizationId},query:{appId:e.appId,pageId:e.pageId,publishedRevisionId:e.publishedRevisionId,viewId:e.viewId}});var h=l,I=m,P=a,R=d,b=p;export{h as declareStudioApp,I as declareStudioAppTemplate,P as declareStudioComponent,R as studioPublishedViewScope,b as studioViewScope};