@content-island/vscode-api-client 0.2.2 → 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-island/vscode-api-client",
-  "version": "0.2.2",
+  "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.21.0"
+    "@content-island/api-client": "0.22.0"
   },
   "devDependencies": {
     "@content-island/common-backend": "*",