@kcflow/core 1.0.2

package/README.md

@@ -0,0 +1,114 @@
+# @kcflow/core
+
+The core type definitions and helper utilities for **KCFlow** - The Cloud-Based Type-Safe API Generator.
+
+This package provides the `t` builder and `defineResource` function required to define your API specification in `kcflow.spec.ts`.
+
+## 📦 Installation
+
+```bash
+npm install @kcflow/core
+```
+
+
+## 🚀 Usage
+
+Create a file named `kcflow.spec.ts` in your project root and define your API structure:
+
+```typescript
+import { defineResource, t } from '@kcflow/core';
+
+export default defineResource({
+  // Define a resource group (e.g., /users)
+  users: {
+    // Define an endpoint (GET /users)
+    list: {
+      method: 'GET',
+      path: '/users',
+      // Define Query Parameters or Body
+      body: t.object({
+        limit: t.number({ required: false }),
+        page: t.number({ required: false }),
+      }),
+      // Define Response Structure
+      response: t.array(
+        t.object({
+          id: t.string(),
+          name: t.string(),
+          email: t.string(),
+          role: t.string({ required: false })
+        })
+      ),
+      // Define Required Headers (Optional)
+      headers: t.object({
+        'Authorization': t.string()
+      })
+    },
+
+    // Define another endpoint (POST /users)
+    create: {
+      method: 'POST',
+      path: '/users',
+      body: t.object({
+        name: t.string(),
+        email: t.string(),
+        password: t.string()
+      }),
+      response: t.object({
+        success: t.boolean(),
+        id: t.string()
+      })
+    }
+  }
+});
+
+```
+
+## 📚 API Reference
+
+### `defineResource(spec)`
+
+The main entry point for defining your API structure.
+
+### `t` (Type Builder)
+
+A helper object to define data types easily.
+
+| Method | Description | Example |
+| --- | --- | --- |
+| `t.string(options?)` | Defines a string field | `t.string()` |
+| `t.number(options?)` | Defines a number field | `t.number()` |
+| `t.boolean(options?)` | Defines a boolean field | `t.boolean()` |
+| `t.object(props, options?)` | Defines a nested object | `t.object({ id: t.string() })` |
+| `t.array(itemType, options?)` | Defines an array | `t.array(t.string())` |
+
+#### Options
+
+All types accept an optional options object:
+
+* `required` (boolean): Defaults to `true`. Set to `false` for optional fields.
+
+```typescript
+// Example: Optional String
+t.string({ required: false }) 
+// Output Type: string | undefined
+
+```
+
+## 🤝 Integration
+
+This package is designed to work with the **KCFlow CLI**. Once you have defined your spec, run:
+
+```bash
+# Generate types and client code
+npx kcflow gen
+
+```
+
+## 📄 License
+
+ISC
+
+```
+
+---

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+export type FieldType = 'string' | 'number' | 'boolean' | 'object' | 'array';
+export interface FieldOptions {
+    required?: boolean;
+}
+export interface FieldDef {
+    type: FieldType;
+    required?: boolean;
+    properties?: Record<string, FieldDef>;
+    itemType?: FieldDef;
+}
+export declare const t: {
+    string: (opts?: FieldOptions) => FieldDef;
+    number: (opts?: FieldOptions) => FieldDef;
+    boolean: (opts?: FieldOptions) => FieldDef;
+    object: (props: Record<string, FieldDef>, opts?: FieldOptions) => FieldDef;
+    array: (item: FieldDef, opts?: FieldOptions) => FieldDef;
+};
+export interface EndpointDef {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    path: string;
+    body?: FieldDef;
+    response?: FieldDef;
+    headers?: FieldDef;
+}
+export interface ResourceDef {
+    [key: string]: EndpointDef | ResourceDef;
+}
+export declare function defineResource(spec: ResourceDef): ResourceDef;
+//# 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":"AACA,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE7E,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAGD,eAAO,MAAM,CAAC;oBACI,YAAY,KAAG,QAAQ;oBACvB,YAAY,KAAG,QAAQ;qBACtB,YAAY,KAAG,QAAQ;oBACxB,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,YAAY,KAAG,QAAQ;kBAK1D,QAAQ,SAAS,YAAY,KAAG,QAAQ;CAKvD,CAAC;AAGF,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;CAC1C;AAGD,wBAAgB,cAAc,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,CAE7D"}

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = void 0;
+exports.defineResource = defineResource;
+// --- The 't' Builder (ตัวช่วยเขียน) ---
+exports.t = {
+    string: (opts) => ({ type: 'string', required: opts?.required ?? true }),
+    number: (opts) => ({ type: 'number', required: opts?.required ?? true }),
+    boolean: (opts) => ({ type: 'boolean', required: opts?.required ?? true }),
+    object: (props, opts) => ({
+        type: 'object',
+        properties: props,
+        required: opts?.required ?? true
+    }),
+    array: (item, opts) => ({
+        type: 'array',
+        itemType: item,
+        required: opts?.required ?? true
+    }),
+};
+// Helper function เพื่อให้ TypeScript InteliSense ทำงานดีขึ้น
+function defineResource(spec) {
+    return spec;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AA6CA,wCAEC;AAjCD,yCAAyC;AAC5B,QAAA,CAAC,GAAG;IACf,MAAM,EAAE,CAAC,IAAmB,EAAY,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,IAAI,IAAI,EAAE,CAAC;IACjG,MAAM,EAAE,CAAC,IAAmB,EAAY,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,IAAI,IAAI,EAAE,CAAC;IACjG,OAAO,EAAE,CAAC,IAAmB,EAAY,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,IAAI,IAAI,EAAE,CAAC;IACnG,MAAM,EAAE,CAAC,KAA+B,EAAE,IAAmB,EAAY,EAAE,CAAC,CAAC;QAC3E,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,IAAI,EAAE,QAAQ,IAAI,IAAI;KACjC,CAAC;IACF,KAAK,EAAE,CAAC,IAAc,EAAE,IAAmB,EAAY,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI,EAAE,QAAQ,IAAI,IAAI;KACjC,CAAC;CACH,CAAC;AAeF,8DAA8D;AAC9D,SAAgB,cAAc,CAAC,IAAiB;IAC9C,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@kcflow/core",
+  "version": "1.0.2",
+  "description": "The core type definitions and helper functions for KCFlow.",
+  "license": "ISC",
+  "author": "PRPAG HOLDING LTD.",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "kcflow",
+    "api-generator",
+    "typescript",
+    "schema",
+    "spec"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.9"
+  }
+}