@content-island/vscode-api-client 0.1.5 → 0.2.0

package/dist/index.d.ts

@@ -11,7 +11,27 @@ declare interface ApiClient {
     getRawContentList: <M extends Model = Model & Record<string, any>>(queryParam?: ContentListQueryParams<M>) => Promise<Content[]>;
     getRawContent: <M extends Model = Model & Record<string, any>>(queryParam: ContentQueryParams<M>) => Promise<Content>;
     getContentListSize: <M extends Model = Model & Record<string, any>>(queryParam?: ContentListSizeQueryParams<M>) => Promise<number>;
-    updateContentFieldValue: (contentId: string, fieldId: string, value: any) => Promise<boolean>;
+    /**
+     * Updates (or upserts, when selected by `fieldName`+`language`) a field value on an existing content.
+     *
+     * The selector chooses how to identify the target:
+     * - `{ fieldName, language }` — by field name and language. Upserts when the pair does not exist, which
+     *   makes it ideal to add translations or fill values for new languages on an existing content.
+     *
+     * @example By reference (preferred for new integrations)
+     * await client.updateContentFieldValue(contentId, { fieldName: 'title', language: 'en' }, 'Hello');
+     */
+    updateContentFieldValue(contentId: string, selector: FieldSelector, value: unknown): Promise<boolean>;
+    /** @deprecated Pass a `FieldSelector` instead: `updateContentFieldValue(contentId, { fieldName: "name", language: "en" }, value)`. */
+    updateContentFieldValue(contentId: string, fieldId: string, value: unknown): Promise<boolean>;
+    uploadMedia: (params: UploadMediaParams) => Promise<Media>;
+    createContent: (params: CreateContentParams) => Promise<CreateContentResponse>;
+    /**
+     * Publishes an existing content: snapshots its current draft fieldValues into publishedValues and
+     * sets its status to "published". Idempotent — re-publishing an already-published content refreshes
+     * the live snapshot from the current draft.
+     */
+    publishContent: (contentId: string) => Promise<boolean>;
 }
 
 declare interface BaseModel {
@@ -23,6 +43,7 @@ declare interface BaseModel {
 export declare type ClientFilter<Type = string | boolean | number> = Type | {
     in?: Type[];
     ne?: Type;
+    nin?: Type[];
 };
 
 export declare interface Content {
@@ -30,6 +51,7 @@ export declare interface Content {
     name: string;
     contentType: Lookup;
     lastUpdate: string;
+    status?: Status;
     fields: Field[];
 }
 
@@ -44,10 +66,27 @@ declare interface ContentTypeField extends Lookup {
     tsType: string;
     isArray: boolean;
     isRequired?: boolean;
+    validations?: Validation[];
 }
 
 export declare const createClient: (options?: VSCodeClientOptions) => VSCodeApiClient;
 
+declare interface CreateContentParams {
+    contentType: string;
+    name: string;
+    content?: Array<{
+        language?: LanguageCode;
+        fields: Array<{
+            name: string;
+            value: any;
+        }>;
+    }>;
+}
+
+declare interface CreateContentResponse {
+    id: string;
+}
+
 declare interface Entity extends BaseModel {
     type: 'entity';
     fieldList?: Field_2[];
@@ -75,7 +114,7 @@ export declare interface Field {
     value: any;
     type: FieldType;
     isArray: boolean;
-    language: string;
+    language: LanguageCode;
 }
 
 declare interface Field_2 {
@@ -87,6 +126,11 @@ declare interface Field_2 {
     validations?: Validation[];
 }
 
+declare type FieldSelector = {
+    fieldName: string;
+    language: string;
+};
+
 export declare type FieldType =
 | 'short-text'
 | 'long-text'
@@ -103,6 +147,7 @@ declare type FilterableFields<M extends Model = Model> = {
     lastUpdate?: ClientFilter<string>;
     language?: M['language'];
     contentType?: ClientFilter<string>;
+    status?: ClientFilter<Status>;
     includeRelatedContent?: boolean;
 } & AllowedFields<M, 'filter'>;
 
@@ -348,6 +393,13 @@ declare type SortableFields<M extends Model> = {
 
 declare type SortOrder = 'asc' | 'desc';
 
+declare type Status = 'draft' | 'published' | 'changed';
+
+declare interface UploadMediaParams {
+    file: Blob | File;
+    fileName?: string;
+}
+
 declare type Validation = { name: string; customArgs?: any };
 
 export declare interface VSCodeApiClient extends ApiClient {

package/dist/index.js

@@ -1,76 +1,76 @@
 import { createClient as I } from "@content-island/api-client";
-import { mapContentToModel as Y } from "@content-island/api-client";
-import * as r from "vscode";
+import { mapContentToModel as z } from "@content-island/api-client";
+import * as c from "vscode";
 import _ from "node:crypto";
 import A from "node:util";
-let E;
+let C;
 const P = () => {
-  if (!E)
+  if (!C)
     throw new Error("Extension context has not been set.");
-  return E;
+  return C;
 }, S = (t) => {
-  E = t;
+  C = t;
 };
 let l = {
   getContext: P,
   setContext: S
 };
-const g = {
+const d = {
   IS_PRODUCTION: !0,
   DEFAULT_API_CLIENT_DOMAIN: "api.contentisland.net",
   DEFAULT_API_CLIENT_VERSION: "1.0",
   DEFAULT_LOGIN_DOMAIN: "app.contentisland.net"
-}, d = "content-island-vscode", u = {
-  SALT: `${d}.salt`,
-  ACCESS_TOKEN_BY_PROJECT_ID: (t) => `${d}.access-token.${t}`,
-  METADATA_BY_PROJECT_ID: (t) => `${d}.metadata.${t}`
+}, 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 = {
   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);
   }
-}, C = {
+}, E = {
   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) => {
-  const s = (t.secureProtocol === void 0 ? g.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", e = t.domain ? t.domain : g.DEFAULT_API_CLIENT_DOMAIN, n = t.apiVersion ? t.apiVersion : g.DEFAULT_API_CLIENT_VERSION;
+  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) => {
-  const s = (t.secureProtocol === void 0 ? g.IS_PRODUCTION : t.secureProtocol) ? "https" : "http", e = t.loginDomain ? t.loginDomain : g.DEFAULT_LOGIN_DOMAIN;
+  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`;
-}, y = 16, p = (t = y) => _.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 () => {
+}, 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 () => {
   const t = l.getContext();
   let o = await t.secrets.get(u.SALT);
-  return o || (o = p(32), await t.secrets.store(u.SALT, o)), o;
-}, k = 32, R = async (t) => {
+  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, k);
-}, w = async (t) => {
+  return await D(t, o, M);
+}, g = async (t) => {
   const o = "Open Login Page";
-  if (await r.window.showInformationMessage(
+  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 = r.Uri.parse(f(t));
-  await r.env.openExternal(e);
-}, M = (t) => {
+  const e = c.Uri.parse(f(t));
+  await c.env.openExternal(e);
+}, R = (t) => {
   try {
     return JSON.parse(t.message);
   } catch {
     return null;
   }
-}, i = (t, o) => async (...s) => {
+}, r = (t, o) => async (...s) => {
   try {
     return await t(...s);
   } catch (e) {
-    const n = M(e);
+    const n = R(e);
     if (n) {
       if (n.status === 401)
-        throw await w(o), new Error("Unauthorized: Please log in to continue.");
-      n.status === 403 && r.window.showErrorMessage("Access forbidden: You do not have permission to perform this action.");
+        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.");
     }
     throw e;
   }
@@ -90,24 +90,24 @@ const g = {
       body: JSON.stringify(a)
     });
   } catch {
-    r.window.showErrorMessage(
+    c.window.showErrorMessage(
       "Unable to connect to the authorization server. Check your network connection and try again."
     );
     return;
   }
   if (!n.ok) {
-    n.status === 401 ? await w(t) : n.status === 403 && r.window.showErrorMessage(
+    n.status === 401 ? await g(t) : n.status === 403 && c.window.showErrorMessage(
       "You do not have permission to access this resource. Please check your access rights in Content Island."
-    ), r.window.showErrorMessage(
+    ), c.window.showErrorMessage(
       "Failed to obtain access token. Please complete the authorization in Content Island."
     );
     return;
   }
   try {
-    const c = await n.json();
-    return (!c?.accessToken || typeof c.accessToken != "string") && (r.window.showErrorMessage("Invalid response from the authorization server."), await w(t)), c.accessToken;
+    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;
   } catch {
-    r.window.showErrorMessage("Error processing response from the authorization server.");
+    c.window.showErrorMessage("Error processing response from the authorization server.");
   }
 }, T = (t) => {
   const o = `PREVIEW_${t.accessToken}`, s = I({ ...t, accessToken: o });
@@ -117,7 +117,7 @@ const g = {
       const e = await s.getProject();
       return {
         ...e,
-        id: await R(e.id)
+        id: await k(e.id)
       };
     }
   };
@@ -131,14 +131,14 @@ const g = {
       const a = await U(t, e, n);
       if (a) {
         s(a, n);
-        const c = await o.getProject();
-        await C.set(c.id, a), await h.set(c.id, n);
+        const i = await o.getProject();
+        await E.set(i.id, a), await h.set(i.id, n);
       }
     },
     authorizeByProjectId: async (e) => {
-      const n = await C.get(e), a = await h.get(e);
+      const n = await E.get(e), a = await h.get(e);
       if (!n || !a) {
-        await w(t);
+        await g(t);
         return;
       }
       s(n, a);
@@ -146,16 +146,22 @@ const g = {
     setVSCodeExtensionContext: (e) => {
       l.setContext(e);
     },
-    getProject: (...e) => i(() => o.getProject(...e), t)(),
-    getContentList: (...e) => i(() => o.getContentList(...e), t)(),
-    getContent: (...e) => i(() => o.getContent(...e), t)(),
-    getRawContentList: (...e) => i(() => o.getRawContentList(...e), t)(),
-    getRawContent: (...e) => i(() => o.getRawContent(...e), t)(),
-    getContentListSize: (...e) => i(() => o.getContentListSize(...e), t)(),
-    updateContentFieldValue: (...e) => i(() => o.updateContentFieldValue(...e), t)()
+    getProject: (...e) => r(() => o.getProject(...e), t)(),
+    getContentList: (...e) => r(() => o.getContentList(...e), t)(),
+    getContent: (...e) => r(() => o.getContent(...e), t)(),
+    getRawContentList: (...e) => r(() => o.getRawContentList(...e), t)(),
+    getRawContent: (...e) => r(() => o.getRawContent(...e), t)(),
+    getContentListSize: (...e) => r(() => o.getContentListSize(...e), t)(),
+    updateContentFieldValue: (e, n, a) => r(
+      () => o.updateContentFieldValue(e, n, a),
+      t
+    )(),
+    uploadMedia: (...e) => r(() => o.uploadMedia(...e), t)(),
+    createContent: (...e) => r(() => o.createContent(...e), t)(),
+    publishContent: (...e) => r(() => o.publishContent(...e), t)()
   };
 };
 export {
   B as createClient,
-  Y as mapContentToModel
+  z as mapContentToModel
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/vscode-api-client",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "Content Island - VSCode Extension API Client",
   "private": false,
   "sideEffects": false,
@@ -24,15 +24,15 @@
     "#*": "./src/*"
   },
   "scripts": {
-    "prebuild:dev": "sh ./create-dev-env.sh",
-    "build:dev": "vite build --mode development",
+    "create-env": "sh ./create-dev-env.sh",
+    "build:dev": "npm run create-env && vite build --mode development",
     "build": "vite build",
     "type-check": "tsc --noEmit --preserveWatchOutput",
     "test": "vitest run -c ./config/test/config.ts",
     "test:watch": "vitest -c ./config/test/config.ts"
   },
   "dependencies": {
-    "@content-island/api-client": "0.17.0"
+    "@content-island/api-client": "0.19.0"
   },
   "devDependencies": {
     "@content-island/common-backend": "*",