@knowledge-stack/ksapi 1.144.0 → 1.145.0

package/src/models/CreateSkillRequest.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { SkillScriptFile } from './SkillScriptFile';
+import type { SkillFile } from './SkillFile';
 import {
-    SkillScriptFileFromJSON,
-    SkillScriptFileFromJSONTyped,
-    SkillScriptFileToJSON,
-    SkillScriptFileToJSONTyped,
-} from './SkillScriptFile';
+    SkillFileFromJSON,
+    SkillFileFromJSONTyped,
+    SkillFileToJSON,
+    SkillFileToJSONTyped,
+} from './SkillFile';
 
 /**
  * Author a skill from a SKILL.md bundle.
@@ -40,11 +40,11 @@ export interface CreateSkillRequest {
      */
     skillMd: string;
     /**
-     * Optional scripts bundled under the skill's scripts/ folder.
-     * @type {Array<SkillScriptFile>}
+     * Optional bundle files at paths relative to the skill root (scripts/, references/, assets/, …). SKILL.md is supplied separately and must not be repeated here.
+     * @type {Array<SkillFile>}
      * @memberof CreateSkillRequest
      */
-    scripts?: Array<SkillScriptFile>;
+    files?: Array<SkillFile>;
 }
 export const CreateSkillRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -64,8 +64,8 @@ export const CreateSkillRequestPropertyValidationAttributesMap: {
     name: {
         maxLength: 255,
     },
-    scripts: {
-        maxItems: 50,
+    files: {
+        maxItems: 2000,
         uniqueItems: false,
     },
 }
@@ -92,7 +92,7 @@ export function CreateSkillRequestFromJSONTyped(json: any, ignoreDiscriminator:
         
         'name': json['name'],
         'skillMd': json['skill_md'],
-        'scripts': json['scripts'] == null ? undefined : ((json['scripts'] as Array<any>).map(SkillScriptFileFromJSON)),
+        'files': json['files'] == null ? undefined : ((json['files'] as Array<any>).map(SkillFileFromJSON)),
     };
 }
 
@@ -109,7 +109,7 @@ export function CreateSkillRequestToJSONTyped(value?: CreateSkillRequest | null,
         
         'name': value['name'],
         'skill_md': value['skillMd'],
-        'scripts': value['scripts'] == null ? undefined : ((value['scripts'] as Array<any>).map(SkillScriptFileToJSON)),
+        'files': value['files'] == null ? undefined : ((value['files'] as Array<any>).map(SkillFileToJSON)),
     };
 }
 

package/src/models/{SkillScriptFile.ts → SkillFile.ts}

@@ -14,25 +14,46 @@
 
 import { mapValues } from '../runtime';
 /**
- * A single script bundled under a skill's ``scripts/`` folder.
+ * One file in a skill bundle, at a path relative to the skill root.
+ * 
+ * Skills carry arbitrary trees (``scripts/office/validate.py``,
+ * ``references/guide.md``, ``assets/logo.png``), so binary files are carried
+ * base64-encoded rather than excluded.
  * @export
- * @interface SkillScriptFile
+ * @interface SkillFile
  */
-export interface SkillScriptFile {
+export interface SkillFile {
     /**
-     * Script file name, e.g. inspect.py
+     * Path relative to the skill root, e.g. scripts/office/run.py
      * @type {string}
-     * @memberof SkillScriptFile
+     * @memberof SkillFile
      */
-    name: string;
+    path: string;
     /**
-     * Script file contents (UTF-8 text).
+     * UTF-8 text, or base64-encoded bytes when encoding=base64.
      * @type {string}
-     * @memberof SkillScriptFile
+     * @memberof SkillFile
      */
     content: string;
+    /**
+     * How `content` is encoded.
+     * @type {SkillFileEncodingEnum}
+     * @memberof SkillFile
+     */
+    encoding?: SkillFileEncodingEnum;
 }
-export const SkillScriptFilePropertyValidationAttributesMap: {
+
+
+/**
+ * @export
+ */
+export const SkillFileEncodingEnum = {
+    Utf8: 'utf-8',
+    Base64: 'base64'
+} as const;
+export type SkillFileEncodingEnum = typeof SkillFileEncodingEnum[keyof typeof SkillFileEncodingEnum];
+
+export const SkillFilePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
         minLength?: number,
@@ -47,49 +68,51 @@ export const SkillScriptFilePropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
-    name: {
-        maxLength: 255,
+    path: {
+        maxLength: 1024,
     },
 }
 
 
 /**
- * Check if a given object implements the SkillScriptFile interface.
+ * Check if a given object implements the SkillFile interface.
  */
-export function instanceOfSkillScriptFile(value: object): value is SkillScriptFile {
-    if (!('name' in value) || value['name'] === undefined) return false;
+export function instanceOfSkillFile(value: object): value is SkillFile {
+    if (!('path' in value) || value['path'] === undefined) return false;
     if (!('content' in value) || value['content'] === undefined) return false;
     return true;
 }
 
-export function SkillScriptFileFromJSON(json: any): SkillScriptFile {
-    return SkillScriptFileFromJSONTyped(json, false);
+export function SkillFileFromJSON(json: any): SkillFile {
+    return SkillFileFromJSONTyped(json, false);
 }
 
-export function SkillScriptFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillScriptFile {
+export function SkillFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): SkillFile {
     if (json == null) {
         return json;
     }
     return {
         
-        'name': json['name'],
+        'path': json['path'],
         'content': json['content'],
+        'encoding': json['encoding'] == null ? undefined : json['encoding'],
     };
 }
 
-export function SkillScriptFileToJSON(json: any): SkillScriptFile {
-    return SkillScriptFileToJSONTyped(json, false);
+export function SkillFileToJSON(json: any): SkillFile {
+    return SkillFileToJSONTyped(json, false);
 }
 
-export function SkillScriptFileToJSONTyped(value?: SkillScriptFile | null, ignoreDiscriminator: boolean = false): any {
+export function SkillFileToJSONTyped(value?: SkillFile | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
 
     return {
         
-        'name': value['name'],
+        'path': value['path'],
         'content': value['content'],
+        'encoding': value['encoding'],
     };
 }
 

package/src/models/SkillResponse.ts

@@ -20,13 +20,13 @@ import {
     ItemPermissionsToJSON,
     ItemPermissionsToJSONTyped,
 } from './ItemPermissions';
-import type { SkillScriptFile } from './SkillScriptFile';
+import type { SkillFile } from './SkillFile';
 import {
-    SkillScriptFileFromJSON,
-    SkillScriptFileFromJSONTyped,
-    SkillScriptFileToJSON,
-    SkillScriptFileToJSONTyped,
-} from './SkillScriptFile';
+    SkillFileFromJSON,
+    SkillFileFromJSONTyped,
+    SkillFileToJSON,
+    SkillFileToJSONTyped,
+} from './SkillFile';
 import type { PathPartApprovalState } from './PathPartApprovalState';
 import {
     PathPartApprovalStateFromJSON,
@@ -103,17 +103,17 @@ export interface SkillResponse {
      */
     skillMd?: string | null;
     /**
-     * Bundled script file names; populated on the detail read and on mutation responses, empty on list.
+     * Bundle file paths relative to the skill root (SKILL.md excluded); populated on the detail read and on mutation responses, empty on list.
      * @type {Array<string>}
      * @memberof SkillResponse
      */
-    scriptNames?: Array<string>;
+    filePaths?: Array<string>;
     /**
-     * Bundled scripts with their contents; populated only on the detail read (GET /skills/{id}), null on list. Lets the editor read the current script set so a PATCH can safely resubmit the whole set.
-     * @type {Array<SkillScriptFile>}
+     * Bundle files with their contents; populated only on the detail read (GET /skills/{id}), null on list. Lets the editor read the current file set so a PATCH can safely resubmit the whole set.
+     * @type {Array<SkillFile>}
      * @memberof SkillResponse
      */
-    scripts?: Array<SkillScriptFile> | null;
+    files?: Array<SkillFile> | null;
     /**
      * Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
      * @type {boolean}
@@ -215,8 +215,8 @@ export function SkillResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'name': json['name'],
         'description': json['description'],
         'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
-        'scriptNames': json['script_names'] == null ? undefined : json['script_names'],
-        'scripts': json['scripts'] == null ? undefined : ((json['scripts'] as Array<any>).map(SkillScriptFileFromJSON)),
+        'filePaths': json['file_paths'] == null ? undefined : json['file_paths'],
+        'files': json['files'] == null ? undefined : ((json['files'] as Array<any>).map(SkillFileFromJSON)),
         'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
         'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
@@ -246,8 +246,8 @@ export function SkillResponseToJSONTyped(value?: SkillResponse | null, ignoreDis
         'name': value['name'],
         'description': value['description'],
         'skill_md': value['skillMd'],
-        'script_names': value['scriptNames'],
-        'scripts': value['scripts'] == null ? undefined : ((value['scripts'] as Array<any>).map(SkillScriptFileToJSON)),
+        'file_paths': value['filePaths'],
+        'files': value['files'] == null ? undefined : ((value['files'] as Array<any>).map(SkillFileToJSON)),
         'has_unpublished_changes': value['hasUnpublishedChanges'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
         'owner': UserInfoToJSON(value['owner']),

package/src/models/UpdateSkillRequest.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { SkillScriptFile } from './SkillScriptFile';
+import type { SkillFile } from './SkillFile';
 import {
-    SkillScriptFileFromJSON,
-    SkillScriptFileFromJSONTyped,
-    SkillScriptFileToJSON,
-    SkillScriptFileToJSONTyped,
-} from './SkillScriptFile';
+    SkillFileFromJSON,
+    SkillFileFromJSONTyped,
+    SkillFileToJSON,
+    SkillFileToJSONTyped,
+} from './SkillFile';
 
 /**
  * Edit working-copy files in place (does NOT cut a version).
@@ -34,11 +34,11 @@ export interface UpdateSkillRequest {
      */
     skillMd?: string | null;
     /**
-     * Replace the working-copy scripts set (add/overwrite/remove to match); null leaves scripts unchanged, [] removes them all.
-     * @type {Array<SkillScriptFile>}
+     * Replace the whole bundle below SKILL.md (add/overwrite/remove to match); null leaves the tree unchanged, [] removes every file.
+     * @type {Array<SkillFile>}
      * @memberof UpdateSkillRequest
      */
-    scripts?: Array<SkillScriptFile> | null;
+    files?: Array<SkillFile> | null;
 }
 export const UpdateSkillRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -55,8 +55,8 @@ export const UpdateSkillRequestPropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
-    scripts: {
-        maxItems: 50,
+    files: {
+        maxItems: 2000,
         uniqueItems: false,
     },
 }
@@ -80,7 +80,7 @@ export function UpdateSkillRequestFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
-        'scripts': json['scripts'] == null ? undefined : ((json['scripts'] as Array<any>).map(SkillScriptFileFromJSON)),
+        'files': json['files'] == null ? undefined : ((json['files'] as Array<any>).map(SkillFileFromJSON)),
     };
 }
 
@@ -96,7 +96,7 @@ export function UpdateSkillRequestToJSONTyped(value?: UpdateSkillRequest | null,
     return {
         
         'skill_md': value['skillMd'],
-        'scripts': value['scripts'] == null ? undefined : ((value['scripts'] as Array<any>).map(SkillScriptFileToJSON)),
+        'files': value['files'] == null ? undefined : ((value['files'] as Array<any>).map(SkillFileToJSON)),
     };
 }
 

package/src/models/index.ts

@@ -257,9 +257,9 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SheetVisibilityChange';
 export * from './SignInRequest';
+export * from './SkillFile';
 export * from './SkillOrder';
 export * from './SkillResponse';
-export * from './SkillScriptFile';
 export * from './SkillSearchResult';
 export * from './SkillVersionResponse';
 export * from './SortDirection';