@andesine/sdk 0.7.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 0.9.0
+
+- `schemas.updateDraft` replaces the fields of a schema draft; people editing the draft see the
+  change live. It takes the draft hash from `schemas.get` and fails if the draft changed since.
+- `schemas.apply` takes an optional `definition` to apply in place of the draft; the draft is
+  replaced only if the apply succeeds.
+- Workspaces have `exampleCollectionID`, the collection with the example content.
+- **Breaking:** `publishing.revertChanges` requires the `entries` permission in addition to
+  `read:publishing`; a read-only key can no longer revert drafts.
+- The README describes Pro usage as a pool shared across the workspace: each seat adds 150,000
+  API calls and 15,000 AI credits. An AI answer uses 10 credits.
+
+## 0.8.0
+
+- `collections.get` returns one collection by `collectionID`, `collectionPath`, or
+  `collectionSlugPath`, with its name, path, and ancestors (`read:collections`).
+- `extensions.listElements` lists the custom elements of the workspace's active extensions (e.g.
+  Tabs): their props, whether they have content, the blocks their content accepts, and the
+  elements that belong inside them (`read:entries`).
+- `extensions.getSelf` and `extensions.verifySession` return `workspacePlan`, the workspace's
+  effective plan (`pro` on instances without billing), so extensions can offer plan features.
+- Extension-managed publishable keys: `extensions.listSelfPublishableKeys`,
+  `createSelfPublishableKey`, `updateSelfPublishableKey`, and `deleteSelfPublishableKey`, for
+  extensions with the `publishable-keys` permission. The keys read published content of their
+  collections (and ask for AI answers with `answers` and the extension's `ai-answers` permission),
+  in their origins. Members can only delete them. They stop while the extension is disabled or
+  revoked; losing `publishable-keys` or `read:publishing`, or uninstalling, deletes them, and
+  losing `ai-answers` removes it.
+- Keys have `extensionID`: the extension that manages the key, or `null`.
+- `extensions.verifySession` takes optional `checks` (`{ collectionID, actions }`, up to 10) and
+  returns `checks` with `allowed` and the `denied` actions. An action is allowed when the
+  member can take it and the extension can read the collection, restricted collections included.
+- `createExtensionBackend().verifySession(headers, { checks })` passes the checks; the results
+  are in `session.checks`.
+
 ## 0.7.0
 
 - `auth.getIdentity` returns `client` (ID and registered name) for OAuth access tokens.

package/README.md

@@ -141,11 +141,11 @@ grant, or app session) in one-minute windows.
 Each workspace also has two monthly meters, which reset at 00:00 UTC on the first
 day of each month:
 
-- **API calls:** each request with an API key or OAuth. Free includes 50,000; Pro
-  includes 500,000 and bills the rest.
-- **AI credits:** an AI answer uses 3 credits, and a semantic search uses 1. Requests
-  from the app use credits too. Free includes 5,000; Pro includes 50,000 and bills
-  the rest.
+- **API calls:** each request with an API key or OAuth. Free includes 50,000; on Pro,
+  each seat adds 150,000 to a pool shared across the workspace, and the rest is billed.
+- **AI credits:** an AI answer uses 10 credits, and a semantic search uses 1. Requests
+  from the app use credits too. Free includes 5,000; on Pro, each seat adds 15,000 to
+  the shared pool, and the rest is billed.
 
 On Free, the meters are hard limits. On Pro, a workspace admin can set a monthly
 spending limit for the billed usage; when it is reached, metered requests stop until

package/dist/{client-TZ83eSln.d.ts → client-54DXm4mG.d.ts}

@@ -1,4 +1,4 @@
-import { N as ContentSchemaMetadata, R as EntryFragment, _n as operations, gn as components, mt as PublishedCollection, yt as PublishedEntryContent, z as EntryProperty } from "./schema-D7yh5Hbs.js";
+import { N as ContentSchemaMetadata, R as EntryFragment, _n as operations, gn as components, mt as PublishedCollection, yt as PublishedEntryContent, z as EntryProperty } from "./schema-DBHoDzsT.js";
 //#region src/workspace.d.ts
 /**
  * Type-only description of one workspace and content source.
@@ -451,7 +451,7 @@ interface APIResources<Workspace extends WorkspaceTypeMap = WorkspaceTypeMap> {
     /**
      * Verify a session token
      *
-     * Verifies a session token from the extension frontend and returns its member. Tokens of other extensions, expired tokens, and tokens of an earlier extension generation fail with NOT_FOUND.
+     * Verifies a session token from the extension frontend and returns its member. Tokens of other extensions, expired tokens, and tokens of an earlier extension generation fail with NOT_FOUND. checks evaluates collection and entry actions for the member, in collections the extension can read (restricted collections included), so the backend can authorize the member's request.
      */
     verifySession: Operation<"extensions.verifySession", Workspace>;
     /**
@@ -472,6 +472,30 @@ interface APIResources<Workspace extends WorkspaceTypeMap = WorkspaceTypeMap> {
      * Returns the extension's configuration, including secret fields, and its revision. Unset fields use their defaults.
      */
     getSelfConfiguration: Operation<"extensions.getSelfConfiguration", Workspace>;
+    /**
+     * List managed publishable keys
+     *
+     * Lists the publishable keys that the extension manages. Requires the publishable-keys permission.
+     */
+    listSelfPublishableKeys: Operation<"extensions.listSelfPublishableKeys", Workspace>;
+    /**
+     * Create a managed publishable key
+     *
+     * Creates a publishable key that the extension manages: read:publishing, and ai-answers with answers. Its collections must be readable by the extension. Members see it in API settings and can only delete it. It stops working while the extension is disabled or revoked; losing the permission or read:publishing, or uninstalling, deletes it, and losing ai-answers removes that permission. Up to 10 keys per installation. Requires the publishable-keys permission.
+     */
+    createSelfPublishableKey: Operation<"extensions.createSelfPublishableKey", Workspace>;
+    /**
+     * Update a managed publishable key
+     *
+     * Changes the name, collections, origins, or AI answers of a key that the extension manages. Requires the publishable-keys permission.
+     */
+    updateSelfPublishableKey: Operation<"extensions.updateSelfPublishableKey", Workspace>;
+    /**
+     * Delete a managed publishable key
+     *
+     * Deletes a key that the extension manages, if it exists. Requires the publishable-keys permission.
+     */
+    deleteSelfPublishableKey: Operation<"extensions.deleteSelfPublishableKey", Workspace>;
     /**
      * Get a storage entry
      *
@@ -496,6 +520,14 @@ interface APIResources<Workspace extends WorkspaceTypeMap = WorkspaceTypeMap> {
      * Lists the extension's storage entries in key order, optionally with a key prefix. A page ends early when its values reach 192 KiB.
      */
     listSelfStorageEntries: Operation<"extensions.listSelfStorageEntries", Workspace>;
+    /**
+     * List custom elements
+     *
+     * The custom elements that the workspace's active extensions draw in the editor, e.g. Tabs: their props, whether they have content, which child blocks their content accepts, and the elements that belong inside them. Write them in MDX as <Name prop="value">content</Name>. The editor guides edits by these rules and offers a clean-up; the API doesn't enforce them.
+     *
+     * Required API key permissions: read:entries. Write permissions also grant read access for the same resource.
+     */
+    listElements: Operation<"extensions.listElements", Workspace>;
   };
   collections: {
     /**
@@ -568,6 +600,19 @@ interface APIResources<Workspace extends WorkspaceTypeMap = WorkspaceTypeMap> {
      * });
      */
     move: Operation<"collections.move", Workspace>;
+    /**
+     * Get a collection
+     *
+     * Returns one collection by collectionID, collectionPath, or collectionSlugPath, with its name, path, and ancestors.
+     *
+     * Required API key permissions: read:collections. Write permissions also grant read access for the same resource.
+     *
+     * @example
+     * await client.collections.get({
+     *   "collectionID": "coll_example"
+     * });
+     */
+    get: Operation<"collections.get", Workspace>;
     /**
      * List collections
      *
@@ -968,10 +1013,36 @@ interface APIResources<Workspace extends WorkspaceTypeMap = WorkspaceTypeMap> {
      * });
      */
     get: Operation<"schemas.get", Workspace>;
+    /**
+     * Update a schema draft
+     *
+     * Replaces the fields of the local schema draft. People editing the draft see the change live. Fields keep their content in entries by ID, so reuse the IDs from schemas.get. Inherited fields stay as they are; don't include them. Entries don't change until schemas.apply.
+     *
+     * Required API key permissions: collections. Write permissions also grant read access for the same resource.
+     *
+     * @example
+     * await client.schemas.updateDraft({
+     *   "schemaID": "sch_example",
+     *   "definition": {
+     *     "formatVersion": 1,
+     *     "fields": [
+     *       {
+     *         "id": "summary",
+     *         "kind": "property",
+     *         "label": "Summary",
+     *         "type": "text",
+     *         "initialValue": "",
+     *         "options": []
+     *       }
+     *     ]
+     *   }
+     * });
+     */
+    updateDraft: Operation<"schemas.updateDraft", Workspace>;
     /**
      * Apply a schema draft
      *
-     * Creates a schema version from the draft and starts any required migration of affected entry content. Review possible content removal before calling: confirmedDataLoss must be true. Use schemaMigrations.get to follow a returned migrationID.
+     * Creates a schema version from the draft, or from definition, and starts any required migration of affected entry content. With definition, the draft is replaced only if the apply succeeds. Review possible content removal before calling: confirmedDataLoss must be true. Use schemaMigrations.get to follow a returned migrationID.
      *
      * Required API key permissions: collections. Write permissions also grant read access for the same resource.
      *
@@ -1333,9 +1404,9 @@ interface APIResources<Workspace extends WorkspaceTypeMap = WorkspaceTypeMap> {
     /**
      * Revert pending publishing changes
      *
-     * Restores selected drafts to the reviewed publication snapshot. This can remove unpublished items and replace draft content. First review publishing.getChannelContent and pass its snapshotID. Use all: true or specific collectionIDs/entryIDs, never both. Requires write access to affected resources in addition to read:publishing.
+     * Restores selected drafts to the reviewed publication snapshot. This can remove unpublished items and replace draft content. First review publishing.getChannelContent and pass its snapshotID. Use all: true or specific collectionIDs/entryIDs, never both. Requires read:publishing and entries, plus write access to affected resources.
      *
-     * Required API key permissions: read:publishing. Write permissions also grant read access for the same resource.
+     * Required API key permissions: read:publishing, entries. Write permissions also grant read access for the same resource.
      *
      * @example
      * await client.publishing.revertChanges({
@@ -1663,4 +1734,4 @@ interface ClientOptions {
 declare const createClient: <Workspace extends WorkspaceTypeMap = WorkspaceTypeMap>(config?: ClientOptions) => AndesineClient<Workspace>;
 //#endregion
 export { WorkspaceCollection as _, ContentPaginationOptions as a, WorkspaceTypeMap as b, APIErrorData as c, OperationError as d, OperationInput as f, SchemaContent as g, ContentListOutput as h, ContentClient as i, APIResponse as l, RequestOptions as m, ClientOptions as n, APIErrorBody as o, OperationOutput as p, createClient as r, APIErrorCode as s, AndesineClient as t, NotModifiedResponse as u, WorkspaceEntry as v, WorkspaceSchema as y };
-//# sourceMappingURL=client-TZ83eSln.d.ts.map
+//# sourceMappingURL=client-54DXm4mG.d.ts.map

package/dist/{client-D7hqNIEY.js → client-C_F2KykP.js}

@@ -333,6 +333,46 @@ const createResources = (request) => ({
 			binary: false,
 			anonymous: false
 		}),
+		listSelfPublishableKeys: operation(request, {
+			method: "get",
+			path: "/extensions/self/publishable-keys",
+			pathParams: [],
+			queryParams: [],
+			body: false,
+			multipart: false,
+			binary: false,
+			anonymous: false
+		}),
+		createSelfPublishableKey: operation(request, {
+			method: "post",
+			path: "/extensions/self/publishable-keys",
+			pathParams: [],
+			queryParams: [],
+			body: true,
+			multipart: false,
+			binary: false,
+			anonymous: false
+		}),
+		updateSelfPublishableKey: operation(request, {
+			method: "patch",
+			path: "/extensions/self/publishable-keys/{keyID}",
+			pathParams: ["keyID"],
+			queryParams: [],
+			body: true,
+			multipart: false,
+			binary: false,
+			anonymous: false
+		}),
+		deleteSelfPublishableKey: operation(request, {
+			method: "delete",
+			path: "/extensions/self/publishable-keys/{keyID}",
+			pathParams: ["keyID"],
+			queryParams: [],
+			body: false,
+			multipart: false,
+			binary: false,
+			anonymous: false
+		}),
 		getSelfStorageEntry: operation(request, {
 			method: "get",
 			path: "/extensions/self/storage/entry",
@@ -376,6 +416,16 @@ const createResources = (request) => ({
 			multipart: false,
 			binary: false,
 			anonymous: false
+		}),
+		listElements: operation(request, {
+			method: "get",
+			path: "/extensions/elements",
+			pathParams: [],
+			queryParams: [],
+			body: false,
+			multipart: false,
+			binary: false,
+			anonymous: false
 		})
 	},
 	collections: {
@@ -429,6 +479,20 @@ const createResources = (request) => ({
 			binary: false,
 			anonymous: false
 		}),
+		get: operation(request, {
+			method: "get",
+			path: "/collections/get",
+			pathParams: [],
+			queryParams: [
+				"collectionID",
+				"collectionPath",
+				"collectionSlugPath"
+			],
+			body: false,
+			multipart: false,
+			binary: false,
+			anonymous: false
+		}),
 		list: operation(request, {
 			method: "get",
 			path: "/collections/list",
@@ -867,6 +931,16 @@ const createResources = (request) => ({
 			binary: false,
 			anonymous: false
 		}),
+		updateDraft: operation(request, {
+			method: "post",
+			path: "/schemas/{schemaID}/draft",
+			pathParams: ["schemaID"],
+			queryParams: [],
+			body: true,
+			multipart: false,
+			binary: false,
+			anonymous: false
+		}),
 		apply: operation(request, {
 			method: "post",
 			path: "/schemas/{schemaID}/apply",
@@ -1477,4 +1551,4 @@ const createClient = (config = {}) => {
 //#endregion
 export { paginate as n, paginatePages as r, createClient as t };
 
-//# sourceMappingURL=client-D7hqNIEY.js.map
+//# sourceMappingURL=client-C_F2KykP.js.map