@content-island/vscode-api-client 0.2.1 → 0.2.3

package/dist/index.d.ts

@@ -32,6 +32,18 @@ declare interface ApiClient {
      * the live snapshot from the current draft.
      */
     publishContent: (contentId: string) => Promise<boolean>;
+    /** Creates an Entity model. Rejects with `ApiClientError` on non-2xx. */
+    createModel: (params: CreateEntityParams) => Promise<SaveModelResponse>;
+    /** Full-upsert of an Entity model: the supplied `fieldList` replaces the stored one. */
+    updateModel: (modelId: string, params: UpdateEntityParams) => Promise<SaveModelResponse>;
+    /** Deletes a model. Rejects with `ApiClientError` (e.g. 409 when referenced). */
+    deleteModel: (modelId: string) => Promise<boolean>;
+    /** Creates an Enum model. Rejects with `ApiClientError` on non-2xx. */
+    createEnum: (params: CreateEnumParams) => Promise<SaveModelResponse>;
+    /** Full-upsert of an Enum model: the supplied `values` replace the stored ones. */
+    updateEnum: (enumId: string, params: UpdateEnumParams) => Promise<SaveModelResponse>;
+    /** Deletes an enum. Rejects with `ApiClientError` (e.g. 409 when referenced). */
+    deleteEnum: (enumId: string) => Promise<boolean>;
 }
 
 declare interface BaseModel {
@@ -87,6 +99,19 @@ declare interface CreateContentResponse {
     id: string;
 }
 
+declare interface CreateEntityParams {
+    name: string;
+    fieldList: FieldSpec[];
+}
+
+declare interface CreateEnumParams {
+    name: string;
+    values: Array<{
+        id?: string;
+        value: string;
+    }>;
+}
+
 declare interface Entity extends BaseModel {
     type: 'entity';
     fieldList?: Field_2[];
@@ -131,6 +156,21 @@ declare type FieldSelector = {
     language: string;
 };
 
+/**
+ * Structured field spec. `id` is optional: present = existing field to preserve
+ * on update, absent = the server creates it. `relatedModelId` is a 24-char model
+ * id used only for `relation`/`enum` types. `order` never appears (server derives
+ * it by list position).
+ */
+declare interface FieldSpec {
+    id?: string;
+    name: string;
+    type: FieldTypeSpec;
+    relatedModelId?: string;
+    isArray?: boolean;
+    validations?: Validation[];
+}
+
 export declare type FieldType =
 | 'short-text'
 | 'long-text'
@@ -142,6 +182,19 @@ export declare type FieldType =
 | 'color'
 | RelatedModelType;
 
+/**
+ * Agent-facing field type discriminator (the value an agent supplies for a field's
+ * `type` when creating/editing a model). The B2B server translates `relation`/`enum`
+ * + `relatedModelId` into the stored `` `${modelId}|${Name}` `` type string; the
+ * agent never supplies a composite type string.
+ *
+ * Derived from common's stored `FieldType` (single source of truth): the 8 primitive
+ * tokens (the stored type minus the composite `${id}|${Name}` form) plus the two
+ * agent-facing discriminators. Distinct from the read-side `FieldType` (common), which
+ * is the composite the server returns on content/project responses.
+ */
+declare type FieldTypeSpec = Exclude<FieldType, `${string}|${string}`> | 'relation' | 'enum';
+
 declare type FilterableFields<M extends Model = Model> = {
     id?: ClientFilter<string>;
     lastUpdate?: ClientFilter<string>;
@@ -388,6 +441,11 @@ declare type QueryParams<M extends Model = Model & Record<string, any>> = Filter
 
 declare type RelatedModelType = `${string}|${string}`;
 
+/** Committed-operation success response for create/update model/enum. */
+declare interface SaveModelResponse {
+    id: string;
+}
+
 declare type SortableFields<M extends Model> = {
     contentType?: SortOrder;
     lastUpdate?: SortOrder;
@@ -397,6 +455,10 @@ declare type SortOrder = 'asc' | 'desc';
 
 declare type Status = 'draft' | 'published' | 'changed';
 
+declare type UpdateEntityParams = CreateEntityParams;
+
+declare type UpdateEnumParams = CreateEnumParams;
+
 declare interface UploadMediaParams {
     file: Blob | File;
     fileName?: string;
@@ -404,7 +466,7 @@ declare interface UploadMediaParams {
 
 declare type Validation = { name: string; customArgs?: any };
 
-export declare interface VSCodeApiClient extends ApiClient {
+export declare interface VSCodeApiClient extends Omit<ApiClient, 'createModel' | 'updateModel' | 'deleteModel' | 'createEnum' | 'updateEnum' | 'deleteEnum'> {
     setVSCodeExtensionContext: (context: vscode.ExtensionContext) => void;
     authorize: (authorizationCode: string, metadata: string) => Promise<void>;
     authorizeByProjectId: (projectId: string) => Promise<void>;

package/dist/index.js

@@ -1,81 +1,74 @@
-import { createClient as I } from "@content-island/api-client";
+import { isApiClientError as I, createClient as A } from "@content-island/api-client";
 import { mapContentToModel as z } from "@content-island/api-client";
 import * as c from "vscode";
 import _ from "node:crypto";
-import A from "node:util";
-let C;
-const P = () => {
-  if (!C)
+import P from "node:util";
+let g;
+const S = () => {
+  if (!g)
     throw new Error("Extension context has not been set.");
-  return C;
-}, S = (t) => {
-  C = t;
+  return g;
+}, L = (t) => {
+  g = t;
 };
 let l = {
-  getContext: P,
-  setContext: S
+  getContext: S,
+  setContext: L
 };
 const d = {
   IS_PRODUCTION: !0,
   DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
   DEFAULT_API_CLIENT_VERSION: "1.0",
   DEFAULT_LOGIN_DOMAIN: "app.contentisland.net"
-}, w = "content-island-vscode", u = {
-  SALT: `${w}.salt`,
-  ACCESS_TOKEN_BY_PROJECT_ID: (t) => `${w}.access-token.${t}`,
-  METADATA_BY_PROJECT_ID: (t) => `${w}.metadata.${t}`
-}, h = {
+}, C = "content-island-vscode", u = {
+  SALT: `${C}.salt`,
+  ACCESS_TOKEN_BY_PROJECT_ID: (t) => `${C}.access-token.${t}`,
+  METADATA_BY_PROJECT_ID: (t) => `${C}.metadata.${t}`
+}, E = {
   get: async (t) => await l.getContext().secrets.get(u.METADATA_BY_PROJECT_ID(t)),
   set: async (t, o) => {
     await l.getContext().secrets.store(u.METADATA_BY_PROJECT_ID(t), o);
   }
-}, E = {
+}, h = {
   get: async (t) => await l.getContext().secrets.get(u.ACCESS_TOKEN_BY_PROJECT_ID(t)),
   set: async (t, o) => {
     await l.getContext().secrets.store(u.ACCESS_TOKEN_BY_PROJECT_ID(t), o);
   }
-}, L = (t) => {
+}, f = (t) => {
   const s = (t.secureProtocol === void 0 ? d.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", e = t.domain ? t.domain : d.DEFAULT_API_CLIENT_DOMAIN, n = t.apiVersion ? t.apiVersion : d.DEFAULT_API_CLIENT_VERSION;
   return `${s}://${e}/api/${n}`;
-}, f = (t) => {
+}, p = (t) => {
   const s = (t.secureProtocol === void 0 ? d.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", e = t.loginDomain ? t.loginDomain : d.DEFAULT_LOGIN_DOMAIN;
   return `${s}://${e}/#/?redirect=vscode`;
-}, p = 16, y = (t = p) => _.randomBytes(t).toString("hex"), O = 64, m = "sha512", x = 1e5, D = async (t, o, s = O) => (await A.promisify(_.pbkdf2)(t, o, x, s, m)).toString("hex"), N = async () => {
+}, y = 16, O = (t = y) => _.randomBytes(t).toString("hex"), x = 64, D = "sha512", m = 1e5, N = async (t, o, s = x) => (await P.promisify(_.pbkdf2)(t, o, m, s, D)).toString("hex"), k = async () => {
   const t = l.getContext();
   let o = await t.secrets.get(u.SALT);
-  return o || (o = y(32), await t.secrets.store(u.SALT, o)), o;
-}, M = 32, k = async (t) => {
-  const o = await N();
-  return await D(t, o, M);
-}, g = async (t) => {
+  return o || (o = O(32), await t.secrets.store(u.SALT, o)), o;
+}, M = 32, R = async (t) => {
+  const o = await k();
+  return await N(t, o, M);
+}, w = async (t) => {
   const o = "Open Login Page";
   if (await c.window.showInformationMessage(
     "You need to log in to Content Island to continue. Do you want to open the login page?",
     o
   ) !== o)
     return;
-  const e = c.Uri.parse(f(t));
+  const e = c.Uri.parse(p(t));
   await c.env.openExternal(e);
-}, R = (t) => {
-  try {
-    return JSON.parse(t.message);
-  } catch {
-    return null;
-  }
 }, r = (t, o) => async (...s) => {
   try {
     return await t(...s);
   } catch (e) {
-    const n = R(e);
-    if (n) {
-      if (n.status === 401)
-        throw await g(o), new Error("Unauthorized: Please log in to continue.");
-      n.status === 403 && c.window.showErrorMessage("Access forbidden: You do not have permission to perform this action.");
+    if (I(e)) {
+      if (e.status === 401)
+        throw await w(o), new Error("Unauthorized: Please log in to continue.");
+      e.status === 403 && c.window.showErrorMessage("Access forbidden: You do not have permission to perform this action.");
     }
     throw e;
   }
 }, U = async (t, o, s) => {
-  const e = L(t);
+  const e = f(t);
   let n;
   const a = {
     authorizationCode: o,
@@ -96,7 +89,7 @@ const d = {
     return;
   }
   if (!n.ok) {
-    n.status === 401 ? await g(t) : n.status === 403 && c.window.showErrorMessage(
+    n.status === 401 ? await w(t) : n.status === 403 && c.window.showErrorMessage(
       "You do not have permission to access this resource. Please check your access rights in Content Island."
     ), c.window.showErrorMessage(
       "Failed to obtain access token. Please complete the authorization in Content Island."
@@ -105,19 +98,19 @@ const d = {
   }
   try {
     const i = await n.json();
-    return (!i?.accessToken || typeof i.accessToken != "string") && (c.window.showErrorMessage("Invalid response from the authorization server."), await g(t)), i.accessToken;
+    return (!i?.accessToken || typeof i.accessToken != "string") && (c.window.showErrorMessage("Invalid response from the authorization server."), await w(t)), i.accessToken;
   } catch {
     c.window.showErrorMessage("Error processing response from the authorization server.");
   }
 }, T = (t) => {
-  const o = `PREVIEW_${t.accessToken}`, s = I({ ...t, accessToken: o });
+  const o = `PREVIEW_${t.accessToken}`, s = A({ ...t, accessToken: o });
   return {
     ...s,
     getProject: async () => {
       const e = await s.getProject();
       return {
         ...e,
-        id: await k(e.id)
+        id: await R(e.id)
       };
     }
   };
@@ -132,13 +125,13 @@ const d = {
       if (a) {
         s(a, n);
         const i = await o.getProject();
-        await E.set(i.id, a), await h.set(i.id, n);
+        await h.set(i.id, a), await E.set(i.id, n);
       }
     },
     authorizeByProjectId: async (e) => {
-      const n = await E.get(e), a = await h.get(e);
+      const n = await h.get(e), a = await E.get(e);
       if (!n || !a) {
-        await g(t);
+        await w(t);
         return;
       }
       s(n, a);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/vscode-api-client",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Content Island - VSCode Extension API Client",
   "private": false,
   "sideEffects": false,
@@ -32,7 +32,7 @@
     "test:watch": "vitest -c ./config/test/config.ts"
   },
   "dependencies": {
-    "@content-island/api-client": "0.20.0"
+    "@content-island/api-client": "0.22.0"
   },
   "devDependencies": {
     "@content-island/common-backend": "*",