@permute/sdk 0.5.0 → 0.6.0

package/README.md

@@ -442,11 +442,11 @@ Identical contents reuse existing files. Changed contents at the same path are s
 
 Visitors sign in through Permute and need app read permission. HTML receives a revision-specific base URL; use relative URLs for bundled and public assets. Inline scripts, external requests, workers, and server runtimes are not supported. Keep API keys and secrets out of compiled browser files. Restore a historical revision with `client.revisions.restore`, then publish the resulting draft to roll back. See the [complete app guide](https://permute.ai/docs/guides/deploy-app) for creation, directory uploads, updates, and rollback.
 
-### Deploy a build directory (SDK 0.5.0+)
+### Deploy a build directory (SDK 0.6.0)
 
 The Node/Bun entry `@permute/sdk/deploy` combines validation, upload, draft save,
-and publication for an existing live app. Available in SDK 0.5.0 and later; the
-individual calls above remain available for separate draft review and publication.
+and publication for an existing live app. Use SDK 0.6.0 for the grant-based app
+API shown here.
 
 ```ts
 import { deployApp } from '@permute/sdk/deploy';
@@ -458,15 +458,13 @@ console.log(deployed.url, deployed.revisionId, deployed.changed);
 The helper rejects symbolic links, unsupported paths, missing `index.html`, and
 oversized builds before uploading. It requires the current draft to be published;
 after reviewing an existing draft, pass its exact `expectedDraft` to approve
-replacing it. Omitted `actions` and `sourceIds` preserve current bindings (an empty
-array clears them). To change action bindings, supply explicit published revisions:
+replacing it. Omitted `actions` preserve current bindings (an empty array clears them). To change action bindings, supply explicit published revisions:
 
 ```ts
 await deployApp(client, {
   appId,
   directory: './dist',
   actions: [{ actionId, revisionId: publishedActionRevisionId }],
-  sourceIds: [databaseId],
 });
 ```
 
@@ -499,10 +497,11 @@ const request = { requestId: crypto.randomUUID(), input: { name: 'Ada' } };
 const receipt = await app.actions.invoke('actn_example', request);
 ```
 
-The client reads the hosted page's revision-pinned base URL. Save the app's `sourceIds` and
+The client reads the hosted page's revision-pinned base URL. Save
 `actions: [{ actionId, revisionId }]` with its site manifest, then publish the app revision.
-Queries require a declared source and the signed-in user's current read permission;
-actions use the pinned published action revision and the user's invocation permission.
+Queries require current app and user read permissions. The query request selects its
+sources; source grants take effect without republishing.
+Actions require both app and user invocation permissions and use the pinned published revision.
 Read scope is source-level; client-supplied SQL is not a row-level authorization policy.
 Keep the same request ID and input when retrying an uncertain action response. The client
 does not retry writes automatically. A 401 requires signing in again.

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 export { PermuteApiError } from './errors.js';
 import type { BusinessAction, BusinessActionList, ActionCreateRequest, ActionDefinition, ActionDefinitionSaveRequest, ActionDefinitionSaved, ActionRequest, ActionReceipt } from './types.js';
-import type { ConnectorSession, ConnectorSessionCreated, ConnectorSessionCreateRequest, Database, AppDraft, AppDraftList, AppCreateRequest, AppUpdateRequest, AppDeleted, AppUploadsRequest, AppUploads, AppSiteSaveRequest, AppUploadFile, DatabaseList, DatabaseCreateRequest, DatabaseDefinition, DatabaseDefinitionSaveRequest, DatabaseDefinitionSaved, DatabaseTables, DatabaseTableCreateRequest, DatabaseTableCreated, DatabaseRecords, DatabaseRecordsQuery, DatabaseTransactionRequest, DatabaseTransactionReceipt, WriteSync, WriteSyncCreateRequest, WriteSyncUpdateRequest, WriteSyncDetail, WriteSyncList, WriteSyncDeleted, WriteSyncDestinations, WriteSyncRun, WriteSyncRunList, WriteSyncRunQuery, WriteSyncExecution, ResourceVersionState, ResourceRevisionList, ResourceRevision, ResourceVersionRequest, ResourcePublishRequest, Fact, FactList, FactWriteRequest, SkillList, SkillContent, SkillWriteRequest, KnowledgeWriteResponse, OperationRunGroup, OperationRunQuery, Operation, OperationList, OperationListQuery, OperationSource, OperationSourceUpdateRequest, OperationUpdateRequest, OperationRunRequest, OperationRunStarted, OperationRunList, OperationRunOutput, DataFlow, DataFlowCreateRequest, DataFlowCommandRequest, DataFlowCommandResponse, Workspace, WorkspaceCreateRequest, WorkspaceDeleteResponse, WorkspaceList, WorkspaceUpdateRequest, AnswerRequest, AnswerJobResponse, AnswerResponse, PermuteClientOptions, PermuteRequestOptions, QueryRequest, QueryResponse, SearchRequest, SearchResponse, SourceDetail, CatalogTable, SourceList, CustomDatasetCreateRequest, DatasetDeleteResponse, DatasetResponse, FileDatasetCreateRequest, FileDatasetResponse, DatasetRows, CustomDatasetResponse, DashboardSource, DashboardSourceUpdateRequest } from './types.js';
+import type { ConnectorSession, ConnectorSessionCreated, ConnectorSessionCreateRequest, Database, AppDraft, AppDraftList, AppCreateRequest, AppUpdateRequest, AppDeleted, AppUploadsRequest, AppUploads, AppSiteSaveRequest, AppGrants, AppGrantSetRequest, AppUploadFile, DatabaseList, DatabaseCreateRequest, DatabaseDefinition, DatabaseDefinitionSaveRequest, DatabaseDefinitionSaved, DatabaseTables, DatabaseTableCreateRequest, DatabaseTableCreated, DatabaseRecords, DatabaseRecordsQuery, DatabaseTransactionRequest, DatabaseTransactionReceipt, WriteSync, WriteSyncCreateRequest, WriteSyncUpdateRequest, WriteSyncDetail, WriteSyncList, WriteSyncDeleted, WriteSyncDestinations, WriteSyncRun, WriteSyncRunList, WriteSyncRunQuery, WriteSyncExecution, ResourceVersionState, ResourceRevisionList, ResourceRevision, ResourceVersionRequest, ResourcePublishRequest, Fact, FactList, FactWriteRequest, SkillList, SkillContent, SkillWriteRequest, KnowledgeWriteResponse, OperationRunGroup, OperationRunQuery, Operation, OperationList, OperationListQuery, OperationSource, OperationSourceUpdateRequest, OperationUpdateRequest, OperationRunRequest, OperationRunStarted, OperationRunList, OperationRunOutput, DataFlow, DataFlowCreateRequest, DataFlowCommandRequest, DataFlowCommandResponse, Workspace, WorkspaceCreateRequest, WorkspaceDeleteResponse, WorkspaceList, WorkspaceUpdateRequest, AnswerRequest, AnswerJobResponse, AnswerResponse, PermuteClientOptions, PermuteRequestOptions, QueryRequest, QueryResponse, SearchRequest, SearchResponse, SourceDetail, CatalogTable, SourceList, CustomDatasetCreateRequest, DatasetDeleteResponse, DatasetResponse, FileDatasetCreateRequest, FileDatasetResponse, DatasetRows, CustomDatasetResponse, DashboardSource, DashboardSourceUpdateRequest } from './types.js';
 type DatasetWriteInput = {
     tables: Record<string, DatasetRows>;
     mode: 'replace';
@@ -93,6 +93,8 @@ export declare class PermuteClient {
         transact(databaseId: string, body: DatabaseTransactionRequest, options?: PermuteRequestOptions): Promise<DatabaseTransactionReceipt>;
     };
     readonly apps: {
+        listGrants(applicationId: string, options?: PermuteRequestOptions): Promise<AppGrants>;
+        setGrant(applicationId: string, resourceId: string, body: AppGrantSetRequest, options?: PermuteRequestOptions): Promise<AppGrants>;
         list(options?: PermuteRequestOptions): Promise<AppDraftList>;
         create(body: AppCreateRequest, options?: PermuteRequestOptions): Promise<AppDraft>;
         get(applicationId: string, options?: PermuteRequestOptions): Promise<AppDraft>;

package/dist/client.js

@@ -335,6 +335,8 @@ export class PermuteClient {
             transact: (databaseId, body, options) => this.request('databaseTransactionsCreate', { pathParams: { databaseId }, body }, options),
         };
         this.apps = {
+            listGrants: (applicationId, options) => this.request('appsGrantsList', { pathParams: { applicationId } }, options),
+            setGrant: (applicationId, resourceId, body, options) => this.request('appsGrantsSet', { pathParams: { applicationId, resourceId }, body }, options),
             prepareUploads: (applicationId, body, options) => this.request('appsUploadsCreate', { pathParams: { applicationId }, body }, options),
             uploadFiles: async (applicationId, files, options) => {
                 const contents = await Promise.all(files.map(async (file) => ({

package/dist/deploy.d.ts

@@ -9,8 +9,6 @@ export interface DeployAppOptions {
     expectedDraft?: AppSiteSaveRequest['expectedDraft'];
     /** Omit to preserve bindings; [] removes them. Revisions must already be published. */
     actions?: AppSiteSaveRequest['actions'];
-    /** Omit to preserve source bindings; [] removes them. */
-    sourceIds?: AppSiteSaveRequest['sourceIds'];
 }
 /** Upload, save, and publish an existing live app. Builds and provisions nothing; never retries mutations. */
 export declare function deployApp(client: PermuteClient, options: DeployAppOptions, requestOptions?: PermuteRequestOptions): Promise<{

package/dist/deploy.js

@@ -45,7 +45,6 @@ async function readBuild(directory, body, spa, signal) {
     if (!manifest.some((file) => file.path === 'index.html') ||
         manifest.reduce((total, file) => total + file.size, 0) > 50 * 1024 * 1024 ||
         new Set(body.actions?.map((action) => action.actionId)).size !== (body.actions?.length ?? 0) ||
-        new Set(body.sourceIds).size !== (body.sourceIds?.length ?? 0) ||
         !validateSite({ ...body, site: { files: manifest, spa } })) {
         throw new PermuteApiError({
             status: 0,
@@ -107,7 +106,6 @@ export async function deployApp(client, options, requestOptions) {
             expectedDraft: expected,
             site: revision.value.site,
             actions: revision.value.actions,
-            sourceIds: revision.value.sourceIds,
         };
         const localManifest = files.map(({ path, data }) => ({
             path,
@@ -118,9 +116,7 @@ export async function deployApp(client, options, requestOptions) {
             previous.site.spa === spa &&
             isDeepStrictEqual(new Map(previous.site.files.map((file) => [file.path, file])), new Map(localManifest.map((file) => [file.path, file]))) &&
             (bindings.actions === undefined ||
-                isDeepStrictEqual(new Map((previous.actions ?? []).map((action) => [action.actionId, action.revisionId])), new Map(bindings.actions.map((action) => [action.actionId, action.revisionId])))) &&
-            (bindings.sourceIds === undefined ||
-                isDeepStrictEqual(new Set(previous.sourceIds ?? []), new Set(bindings.sourceIds)))) {
+                isDeepStrictEqual(new Map((previous.actions ?? []).map((action) => [action.actionId, action.revisionId])), new Map(bindings.actions.map((action) => [action.actionId, action.revisionId]))))) {
             const current = await client.revisions.list(appId, requestOptions);
             if (current.version !== history.version)
                 conflict('App changed during inspection. Review the current refs.');

package/dist/generated/openapi.d.ts

@@ -253,6 +253,30 @@ export interface components {
                 workspaceId: string;
             }[];
         };
+        AppGrantParams: {
+            applicationId: string;
+            resourceId: string;
+        };
+        AppGrants: {
+            canManage: boolean;
+            items: {
+                /** Format: date-time */
+                expiresAt?: string | null;
+                /** @enum {string} */
+                level: 'read' | 'write' | 'admin';
+                resourceId: string;
+                resourceType?: string;
+                subResourceId?: string;
+            }[];
+        };
+        AppGrantSetRequest: {
+            /** Format: date-time */
+            expiresAt?: string | null;
+            /** @enum {string|null} */
+            level: 'read' | 'write' | 'admin' | null;
+            resourceType?: string;
+            subResourceId?: string;
+        };
         AppIdParams: {
             applicationId: string;
         };
@@ -273,7 +297,6 @@ export interface components {
                 }[];
                 spa: boolean;
             };
-            sourceIds?: string[];
         };
         AppUpdateRequest: {
             description: string;

package/dist/generated/runtime-contract.d.ts

@@ -8,7 +8,7 @@ export interface RuntimeRoute {
     querySchema: JsonSchema | null;
     responseSchema: JsonSchema;
 }
-export type PublicApiOperationId = 'connectorSessionsCreate' | 'connectorSessionsGet' | 'resourceRevisionsList' | 'resourceRevisionsGet' | 'resourceRevisionsRestore' | 'resourcesPublish' | 'actionsList' | 'actionsCreate' | 'actionsGet' | 'actionsDelete' | 'actionDefinitionGet' | 'actionDefinitionSave' | 'actionsInvoke' | 'workspacesList' | 'workspacesCreate' | 'workspacesGet' | 'workspacesUpdate' | 'workspacesDelete' | 'sourcesList' | 'sourcesGet' | 'dashboardsSourceGet' | 'dashboardsSourceUpdate' | 'datasetsCreate' | 'datasetsGetByKey' | 'datasetsGet' | 'datasetsDelete' | 'datasetsDownload' | 'datasetsWriteTables' | 'searchCreate' | 'answerJobsCreate' | 'answerJobsGet' | 'queriesCreate' | 'operationRunsList' | 'operationsList' | 'operationsGet' | 'operationsUpdate' | 'operationsSourceGet' | 'operationsSourceUpdate' | 'operationsRunsList' | 'operationsRun' | 'operationsRunOutput' | 'dataFlowsCreate' | 'dataFlowsGet' | 'dataFlowsCommand' | 'factsList' | 'factsCreate' | 'factsGet' | 'factsUpdate' | 'factsDelete' | 'skillsList' | 'skillsGet' | 'skillsUpdate' | 'skillsDelete' | 'organizationSkillsList' | 'organizationSkillsGet' | 'organizationSkillsUpdate' | 'organizationSkillsDelete' | 'databasesList' | 'databasesCreate' | 'databasesGet' | 'databasesDelete' | 'databaseDefinitionGet' | 'databaseDefinitionSave' | 'databaseTablesList' | 'databaseTablesCreate' | 'databaseRecordsList' | 'databaseTransactionsCreate' | 'appsList' | 'appsCreate' | 'appsGet' | 'appsUpdate' | 'appsDelete' | 'appsUploadsCreate' | 'appsSiteUpdate' | 'writeSyncsList' | 'writeSyncsCreate' | 'writeSyncsDestinations' | 'writeSyncsGet' | 'writeSyncsUpdate' | 'writeSyncsDelete' | 'writeSyncsPreview' | 'writeSyncsPause' | 'writeSyncsListRuns' | 'writeSyncsGetRun' | 'writeSyncsExecute';
+export type PublicApiOperationId = 'connectorSessionsCreate' | 'connectorSessionsGet' | 'resourceRevisionsList' | 'resourceRevisionsGet' | 'resourceRevisionsRestore' | 'resourcesPublish' | 'actionsList' | 'actionsCreate' | 'actionsGet' | 'actionsDelete' | 'actionDefinitionGet' | 'actionDefinitionSave' | 'actionsInvoke' | 'workspacesList' | 'workspacesCreate' | 'workspacesGet' | 'workspacesUpdate' | 'workspacesDelete' | 'sourcesList' | 'sourcesGet' | 'dashboardsSourceGet' | 'dashboardsSourceUpdate' | 'datasetsCreate' | 'datasetsGetByKey' | 'datasetsGet' | 'datasetsDelete' | 'datasetsDownload' | 'datasetsWriteTables' | 'searchCreate' | 'answerJobsCreate' | 'answerJobsGet' | 'queriesCreate' | 'operationRunsList' | 'operationsList' | 'operationsGet' | 'operationsUpdate' | 'operationsSourceGet' | 'operationsSourceUpdate' | 'operationsRunsList' | 'operationsRun' | 'operationsRunOutput' | 'dataFlowsCreate' | 'dataFlowsGet' | 'dataFlowsCommand' | 'factsList' | 'factsCreate' | 'factsGet' | 'factsUpdate' | 'factsDelete' | 'skillsList' | 'skillsGet' | 'skillsUpdate' | 'skillsDelete' | 'organizationSkillsList' | 'organizationSkillsGet' | 'organizationSkillsUpdate' | 'organizationSkillsDelete' | 'databasesList' | 'databasesCreate' | 'databasesGet' | 'databasesDelete' | 'databaseDefinitionGet' | 'databaseDefinitionSave' | 'databaseTablesList' | 'databaseTablesCreate' | 'databaseRecordsList' | 'databaseTransactionsCreate' | 'appsGrantsList' | 'appsGrantsSet' | 'appsList' | 'appsCreate' | 'appsGet' | 'appsUpdate' | 'appsDelete' | 'appsUploadsCreate' | 'appsSiteUpdate' | 'writeSyncsList' | 'writeSyncsCreate' | 'writeSyncsDestinations' | 'writeSyncsGet' | 'writeSyncsUpdate' | 'writeSyncsDelete' | 'writeSyncsPreview' | 'writeSyncsPause' | 'writeSyncsListRuns' | 'writeSyncsGetRun' | 'writeSyncsExecute';
 export declare const publicApiRoutes: Record<PublicApiOperationId, RuntimeRoute>;
 export declare const Providers: {
     readonly ACUMATICA: "acumatica";

package/dist/generated/runtime-contract.js

@@ -6521,6 +6521,136 @@ export const publicApiRoutes = {
             additionalProperties: false,
         },
     },
+    appsGrantsList: {
+        operationId: 'appsGrantsList',
+        method: 'GET',
+        path: '/v1/apps/{applicationId}/grants',
+        scope: 'workspace',
+        bodySchema: null,
+        querySchema: null,
+        responseSchema: {
+            type: 'object',
+            properties: {
+                items: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            resourceId: {
+                                type: 'string',
+                                minLength: 1,
+                                maxLength: 128,
+                            },
+                            resourceType: {
+                                type: 'string',
+                                minLength: 1,
+                                maxLength: 128,
+                            },
+                            subResourceId: {
+                                type: 'string',
+                                minLength: 1,
+                                maxLength: 128,
+                            },
+                            expiresAt: {
+                                type: 'string',
+                                format: 'date-time',
+                                nullable: true,
+                            },
+                            level: {
+                                type: 'string',
+                                enum: ['read', 'write', 'admin'],
+                            },
+                        },
+                        required: ['resourceId', 'level'],
+                        additionalProperties: false,
+                    },
+                },
+                canManage: {
+                    type: 'boolean',
+                },
+            },
+            required: ['items', 'canManage'],
+            additionalProperties: false,
+        },
+    },
+    appsGrantsSet: {
+        operationId: 'appsGrantsSet',
+        method: 'PUT',
+        path: '/v1/apps/{applicationId}/grants/{resourceId}',
+        scope: 'workspace',
+        bodySchema: {
+            type: 'object',
+            properties: {
+                resourceType: {
+                    type: 'string',
+                    minLength: 1,
+                    maxLength: 128,
+                },
+                subResourceId: {
+                    type: 'string',
+                    minLength: 1,
+                    maxLength: 128,
+                },
+                expiresAt: {
+                    type: 'string',
+                    format: 'date-time',
+                    nullable: true,
+                },
+                level: {
+                    type: 'string',
+                    enum: ['read', 'write', 'admin', null],
+                    nullable: true,
+                },
+            },
+            required: ['level'],
+            additionalProperties: false,
+        },
+        querySchema: null,
+        responseSchema: {
+            type: 'object',
+            properties: {
+                items: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            resourceId: {
+                                type: 'string',
+                                minLength: 1,
+                                maxLength: 128,
+                            },
+                            resourceType: {
+                                type: 'string',
+                                minLength: 1,
+                                maxLength: 128,
+                            },
+                            subResourceId: {
+                                type: 'string',
+                                minLength: 1,
+                                maxLength: 128,
+                            },
+                            expiresAt: {
+                                type: 'string',
+                                format: 'date-time',
+                                nullable: true,
+                            },
+                            level: {
+                                type: 'string',
+                                enum: ['read', 'write', 'admin'],
+                            },
+                        },
+                        required: ['resourceId', 'level'],
+                        additionalProperties: false,
+                    },
+                },
+                canManage: {
+                    type: 'boolean',
+                },
+            },
+            required: ['items', 'canManage'],
+            additionalProperties: false,
+        },
+    },
     appsList: {
         operationId: 'appsList',
         method: 'GET',
@@ -7018,14 +7148,6 @@ export const publicApiRoutes = {
                     },
                     maxItems: 100,
                 },
-                sourceIds: {
-                    type: 'array',
-                    items: {
-                        type: 'string',
-                        minLength: 1,
-                    },
-                    maxItems: 100,
-                },
                 expectedDraft: {
                     type: 'object',
                     properties: {

package/dist/types.d.ts

@@ -1,5 +1,7 @@
 import type { components } from './generated/openapi.js';
 type PublicApiSchema<Name extends keyof components['schemas']> = components['schemas'][Name];
+export type AppGrants = PublicApiSchema<'AppGrants'>;
+export type AppGrantSetRequest = PublicApiSchema<'AppGrantSetRequest'>;
 export type BusinessAction = PublicApiSchema<'BusinessAction'>;
 export type BusinessActionList = PublicApiSchema<'BusinessActionList'>;
 export type ActionCreateRequest = PublicApiSchema<'ActionCreateRequest'>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@permute/sdk",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "TypeScript client for the Permute public API",
   "type": "module",
   "license": "Apache-2.0",