@c-time/frelio-data-json 1.0.0 → 1.1.0

package/README.md

@@ -0,0 +1,62 @@
+# @c-time/frelio-data-json
+
+Type definitions for Frelio data JSON output.
+
+## Installation
+
+```bash
+npm install @c-time/frelio-data-json
+```
+
+## Usage
+
+```typescript
+import type { FrelioDataJson } from '@c-time/frelio-data-json'
+
+const data: FrelioDataJson = {
+  type: 'create',
+  template: 'article/detail.html',
+  outputFile: 'articles/my-article.html',
+  data: { title: 'My Article', body: '...' }
+}
+```
+
+## Type Guards
+
+```typescript
+import { isFrelioDataJson, isFrelioDataJsonArray } from '@c-time/frelio-data-json'
+
+// Validate single entry
+if (isFrelioDataJson(unknownData)) {
+  console.log(unknownData.outputFile)
+}
+
+// Validate array
+if (isFrelioDataJsonArray(unknownArray)) {
+  unknownArray.forEach(entry => console.log(entry.type))
+}
+```
+
+## Types
+
+### FrelioDataJson
+
+```typescript
+type FrelioDataJson = {
+  type: 'create' | 'update' | 'delete'
+  template: string
+  outputFile: string
+  data: Record<string, unknown>
+}
+```
+
+| Field | Description |
+|-------|-------------|
+| `type` | Operation type: `create`, `update`, or `delete` |
+| `template` | Template file path |
+| `outputFile` | Output file path |
+| `data` | Data to pass to the template |
+
+## License
+
+MIT

package/dist/guards.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Type guard functions for Frelio data JSON.
+ */
+import type { FrelioDataJson } from './types.js';
+/**
+ * 型ガード: FrelioDataJson
+ */
+export declare function isFrelioDataJson(value: unknown): value is FrelioDataJson;
+/**
+ * 型ガード: FrelioDataJson[]
+ */
+export declare function isFrelioDataJsonArray(value: unknown): value is FrelioDataJson[];
+//# sourceMappingURL=guards.d.ts.map

package/dist/guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../src/guards.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAYxE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,EAAE,CAE/E"}

package/dist/guards.js

@@ -0,0 +1,24 @@
+/**
+ * Type guard functions for Frelio data JSON.
+ */
+/**
+ * 型ガード: FrelioDataJson
+ */
+export function isFrelioDataJson(value) {
+    if (typeof value !== 'object' || value === null) {
+        return false;
+    }
+    const obj = value;
+    return ((obj.type === 'create' || obj.type === 'update' || obj.type === 'delete') &&
+        typeof obj.template === 'string' &&
+        typeof obj.outputFile === 'string' &&
+        typeof obj.data === 'object' &&
+        obj.data !== null);
+}
+/**
+ * 型ガード: FrelioDataJson[]
+ */
+export function isFrelioDataJsonArray(value) {
+    return Array.isArray(value) && value.every(isFrelioDataJson);
+}
+//# sourceMappingURL=guards.js.map

package/dist/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../src/guards.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAA;IACd,CAAC;IACD,MAAM,GAAG,GAAG,KAAgC,CAAA;IAC5C,OAAO,CACL,CAAC,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;QACzE,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ;QAChC,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ;QAClC,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAC5B,GAAG,CAAC,IAAI,KAAK,IAAI,CAClB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAc;IAClD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AAC9D,CAAC"}

package/dist/index.d.ts

@@ -1,22 +1,28 @@
 /**
- * frelio-data-json 操作タイプ
+ * @c-time/frelio-data-json
+ *
+ * Type definitions for Frelio data JSON output.
+ *
+ * @example
+ * ```typescript
+ * import type { FrelioDataJson } from '@c-time/frelio-data-json'
+ * import { isFrelioDataJson } from '@c-time/frelio-data-json'
+ *
+ * const data: FrelioDataJson = {
+ *   type: 'create',
+ *   template: 'article/detail.html',
+ *   outputFile: 'articles/my-article.html',
+ *   data: { title: 'My Article', body: '...' }
+ * }
+ *
+ * // Validate unknown data
+ * if (isFrelioDataJson(unknownData)) {
+ *   console.log(unknownData.outputFile)
+ * }
+ * ```
+ *
+ * @packageDocumentation
  */
-export type FrelioDataJsonType = "create" | "update" | "delete";
-/**
- * frelio-data-json 単一エントリ
- */
-export type FrelioDataJson = {
-    type: FrelioDataJsonType;
-    template: string;
-    outputFile: string;
-    data: Record<string, unknown>;
-};
-/**
- * 型ガード: FrelioDataJson
- */
-export declare function isFrelioDataJson(value: unknown): value is FrelioDataJson;
-/**
- * 型ガード: FrelioDataJson[]
- */
-export declare function isFrelioDataJsonArray(value: unknown): value is FrelioDataJson[];
+export type { FrelioDataJsonType, FrelioDataJson } from './types.js';
+export { isFrelioDataJson, isFrelioDataJsonArray } from './guards.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE/D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,kBAAkB,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAYxE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,EAAE,CAE/E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,YAAY,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAGpE,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -1,21 +1,28 @@
 /**
- * 型ガード: FrelioDataJson
+ * @c-time/frelio-data-json
+ *
+ * Type definitions for Frelio data JSON output.
+ *
+ * @example
+ * ```typescript
+ * import type { FrelioDataJson } from '@c-time/frelio-data-json'
+ * import { isFrelioDataJson } from '@c-time/frelio-data-json'
+ *
+ * const data: FrelioDataJson = {
+ *   type: 'create',
+ *   template: 'article/detail.html',
+ *   outputFile: 'articles/my-article.html',
+ *   data: { title: 'My Article', body: '...' }
+ * }
+ *
+ * // Validate unknown data
+ * if (isFrelioDataJson(unknownData)) {
+ *   console.log(unknownData.outputFile)
+ * }
+ * ```
+ *
+ * @packageDocumentation
  */
-export function isFrelioDataJson(value) {
-    if (typeof value !== 'object' || value === null) {
-        return false;
-    }
-    const obj = value;
-    return ((obj.type === 'create' || obj.type === 'update' || obj.type === 'delete') &&
-        typeof obj.template === 'string' &&
-        typeof obj.outputFile === 'string' &&
-        typeof obj.data === 'object' &&
-        obj.data !== null);
-}
-/**
- * 型ガード: FrelioDataJson[]
- */
-export function isFrelioDataJsonArray(value) {
-    return Array.isArray(value) && value.every(isFrelioDataJson);
-}
+// Type guards
+export { isFrelioDataJson, isFrelioDataJsonArray } from './guards.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAA;IACd,CAAC;IACD,MAAM,GAAG,GAAG,KAAgC,CAAA;IAC5C,OAAO,CACL,CAAC,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;QACzE,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ;QAChC,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ;QAClC,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAC5B,GAAG,CAAC,IAAI,KAAK,IAAI,CAClB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAc;IAClD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AAC9D,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAKH,cAAc;AACd,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Type definitions for Frelio data JSON output.
+ */
+/**
+ * frelio-data-json 操作タイプ
+ */
+export type FrelioDataJsonType = 'create' | 'update' | 'delete';
+/**
+ * frelio-data-json 単一エントリ
+ *
+ * データ JSON ジェネレーターが出力し、gentl が消費する中間形式。
+ *
+ * @example
+ * ```json
+ * {
+ *   "type": "create",
+ *   "template": "article/detail.html",
+ *   "outputFile": "articles/my-article.html",
+ *   "data": { "title": "My Article", "body": "..." }
+ * }
+ * ```
+ */
+export type FrelioDataJson = {
+    /** 操作タイプ: create（新規）, update（更新）, delete（削除） */
+    type: FrelioDataJsonType;
+    /** テンプレートファイルのパス */
+    template: string;
+    /** 出力ファイルのパス */
+    outputFile: string;
+    /** テンプレートに渡すデータ */
+    data: Record<string, unknown>;
+};
+//# 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;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,gDAAgD;IAChD,IAAI,EAAE,kBAAkB,CAAA;IACxB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,gBAAgB;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Type definitions for Frelio data JSON output.
+ */
+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":"AAAA;;GAEG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@c-time/frelio-data-json",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Type definitions for frelio data JSON output",
   "type": "module",
   "main": "./dist/index.js",