@alistigo/artifact-config-list-format 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mikael Labrut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+# @alistigo/artifact-config-list-format
+
+JSON Schema and TypeScript types for the Alistigo list artifact config document.
+
+## Install
+
+```sh
+pnpm add @alistigo/artifact-config-list-format
+```
+
+## Usage
+
+```ts
+import { validateListConfig, type ListArtifactConfig } from "@alistigo/artifact-config-list-format";
+
+const config = validateListConfig({ readonly: true });
+// => { readonly: true }
+```

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export type { ListArtifactConfig } from "./types.js";
+export { validateListConfig } from "./validate.js";
+export declare const listConfigSchema: {
+    $schema: string;
+    $id: string;
+    title: string;
+    description: string;
+    type: string;
+    properties: {
+        readonly: {
+            type: string;
+            default: boolean;
+        };
+    };
+    additionalProperties: boolean;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGnD,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;CAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { validateListConfig } from "./validate.js";
+import listConfigSchemaJson from "./schemas/list-config.json" with { type: "json" };
+export const listConfigSchema = listConfigSchemaJson;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,oBAAoB,MAAM,4BAA4B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACpF,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC"}

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,69 @@
+import { describe, expect, it } from "bun:test";
+import { listConfigSchema, validateListConfig } from "./index.js";
+describe("validateListConfig", () => {
+    describe("valid configs", () => {
+        it("accepts readonly=true", () => {
+            const result = validateListConfig({ readonly: true });
+            expect(result).toEqual({ readonly: true });
+        });
+        it("accepts readonly=false", () => {
+            const result = validateListConfig({ readonly: false });
+            expect(result).toEqual({ readonly: false });
+        });
+        it("defaults readonly to false when the field is missing", () => {
+            const result = validateListConfig({});
+            expect(result).toEqual({ readonly: false });
+        });
+        it("treats null as empty config (defaults apply)", () => {
+            const result = validateListConfig(null);
+            expect(result).toEqual({ readonly: false });
+        });
+        it("ignores extra fields and returns only list-relevant fields", () => {
+            const result = validateListConfig({ readonly: true, app: "alistigo", lang: "en" });
+            expect(result).toEqual({ readonly: true });
+            expect(result).not.toHaveProperty("app");
+            expect(result).not.toHaveProperty("lang");
+        });
+        it("ignores unknown extra fields with no readonly field", () => {
+            const result = validateListConfig({ app: "alistigo", someOtherField: 42 });
+            expect(result).toEqual({ readonly: false });
+        });
+    });
+    describe("invalid configs", () => {
+        it("throws if input is a string", () => {
+            expect(() => validateListConfig("true")).toThrow(TypeError);
+        });
+        it("throws if input is a number", () => {
+            expect(() => validateListConfig(42)).toThrow(TypeError);
+        });
+        it("throws if input is a boolean", () => {
+            expect(() => validateListConfig(true)).toThrow(TypeError);
+        });
+        it("throws if input is an array", () => {
+            expect(() => validateListConfig([])).toThrow(TypeError);
+        });
+        it("throws if readonly is a string instead of boolean", () => {
+            expect(() => validateListConfig({ readonly: "true" })).toThrow(TypeError);
+        });
+        it("throws if readonly is a number instead of boolean", () => {
+            expect(() => validateListConfig({ readonly: 1 })).toThrow(TypeError);
+        });
+        it("throws if readonly is null", () => {
+            expect(() => validateListConfig({ readonly: null })).toThrow(TypeError);
+        });
+    });
+});
+describe("listConfigSchema", () => {
+    it("exports the JSON Schema object", () => {
+        expect(listConfigSchema).toBeDefined();
+        expect(listConfigSchema.$schema).toBe("http://json-schema.org/draft-07/schema#");
+        expect(listConfigSchema.type).toBe("object");
+    });
+    it("schema has readonly property defined", () => {
+        expect(listConfigSchema.properties.readonly).toEqual({ type: "boolean", default: false });
+    });
+    it("schema forbids additional properties", () => {
+        expect(listConfigSchema.additionalProperties).toBe(false);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAElE,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;YAC/B,MAAM,MAAM,GAAG,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,MAAM,MAAM,GAAG,kBAAkB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,MAAM,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,MAAM,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,MAAM,GAAG,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACnF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,MAAM,GAAG,kBAAkB,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC,CAAC;YAC3E,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,CAAC,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC;QACvC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;QACjF,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@alistigo/artifact-config-list-format",
+  "version": "0.1.0",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./schemas/list-config.json": "./src/schemas/list-config.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src/schemas"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "module": "./index.js"
+}

package/dist/schemas/list-config.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://alistigo.ai/schema/v1/artifact-config/list.json",
+    "title": "List Artifact Config",
+    "description": "Configuration document for the Alistigo list artifact.",
+    "type": "object",
+    "properties": {
+        "readonly": { "type": "boolean", "default": false }
+    },
+    "additionalProperties": false
+}

package/dist/types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration document for the Alistigo list artifact.
+ * Stored as the artifact's config document alongside the list document.
+ */
+export interface ListArtifactConfig {
+    /** When true, the list cannot be modified by users. Defaults to false. */
+    readonly?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/validate.d.ts

@@ -0,0 +1,16 @@
+import type { ListArtifactConfig } from "./types.js";
+/**
+ * Validate and extract list-specific config from an unknown value.
+ *
+ * Rules:
+ * - Input must be a non-array object (null is treated as empty config).
+ * - If `readonly` is present, it must be a boolean.
+ * - Extra fields are ignored — this function extracts only list-relevant fields,
+ *   so it composes safely with the aggregate artifact-config validator that may
+ *   pass in a config object containing fields like `app` or `lang`.
+ * - Returns a `ListArtifactConfig` with defaults applied (`readonly` defaults to false).
+ *
+ * @throws {TypeError} if the input is not an object, or if `readonly` is not a boolean.
+ */
+export declare function validateListConfig(value: unknown): ListArtifactConfig;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD;;;;;;;;;;;;GAYG;AAEH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB,CAuBrE"}

package/dist/validate.js

@@ -0,0 +1,31 @@
+/**
+ * Validate and extract list-specific config from an unknown value.
+ *
+ * Rules:
+ * - Input must be a non-array object (null is treated as empty config).
+ * - If `readonly` is present, it must be a boolean.
+ * - Extra fields are ignored — this function extracts only list-relevant fields,
+ *   so it composes safely with the aggregate artifact-config validator that may
+ *   pass in a config object containing fields like `app` or `lang`.
+ * - Returns a `ListArtifactConfig` with defaults applied (`readonly` defaults to false).
+ *
+ * @throws {TypeError} if the input is not an object, or if `readonly` is not a boolean.
+ */
+// fallow-ignore-next-line complexity
+export function validateListConfig(value) {
+    if (value === null) {
+        return { readonly: false };
+    }
+    if (typeof value !== "object" || Array.isArray(value)) {
+        throw new TypeError(`List artifact config must be an object, got ${Array.isArray(value) ? "array" : typeof value}`);
+    }
+    const raw = value;
+    if ("readonly" in raw && raw.readonly !== undefined) {
+        if (typeof raw.readonly !== "boolean") {
+            throw new TypeError(`List artifact config: "readonly" must be a boolean, got ${typeof raw.readonly}`);
+        }
+        return { readonly: raw.readonly };
+    }
+    return { readonly: false };
+}
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,qCAAqC;AACrC,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,SAAS,CACjB,+CAA+C,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,KAAK,EAAE,CAC/F,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,KAAgC,CAAC;IAE7C,IAAI,UAAU,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpD,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,IAAI,SAAS,CACjB,2DAA2D,OAAO,GAAG,CAAC,QAAQ,EAAE,CACjF,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAmB,EAAE,CAAC;IAC/C,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC"}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@alistigo/artifact-config-list-format",
+  "version": "0.1.0",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./schemas/list-config.json": "./src/schemas/list-config.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src/schemas"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/schemas/list-config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://alistigo.ai/schema/v1/artifact-config/list.json",
+  "title": "List Artifact Config",
+  "description": "Configuration document for the Alistigo list artifact.",
+  "type": "object",
+  "properties": {
+    "readonly": { "type": "boolean", "default": false }
+  },
+  "additionalProperties": false
+}