@rudderjs/orm 0.0.6

package/dist/resource.js

@@ -0,0 +1,115 @@
+// ─── JsonResource ───────────────────────────────────────────
+/**
+ * Base class for API resource transformations.
+ *
+ * @example
+ * class UserResource extends JsonResource<User> {
+ *   toArray() {
+ *     return {
+ *       id:    this.resource.id,
+ *       name:  this.resource.name,
+ *       email: this.resource.email,
+ *       // conditional
+ *       admin: this.when(this.resource.role === 'admin', true),
+ *       posts: this.whenLoaded('posts', PostResource.collection(this.resource.posts as Post[])),
+ *     }
+ *   }
+ * }
+ *
+ * // In a route handler:
+ * res.json(new UserResource(user).toArray())
+ * res.json(UserResource.collection(users).toResponse())
+ */
+export class JsonResource {
+    resource;
+    constructor(resource) {
+        this.resource = resource;
+    }
+    when(condition, value, fallback) {
+        return condition ? value : fallback;
+    }
+    /**
+     * Include `then` only when `value` is not null/undefined.
+     * If `then` is a function it receives the non-null value.
+     */
+    whenNotNull(value, then, fallback) {
+        if (value !== null && value !== undefined) {
+            return typeof then === 'function'
+                ? then(value)
+                : then;
+        }
+        return fallback;
+    }
+    whenLoaded(relation, value, fallback) {
+        const res = this.resource;
+        if (relation in res && res[relation] !== undefined) {
+            return value !== undefined ? value : res[relation];
+        }
+        return fallback;
+    }
+    /**
+     * Merge `attributes` into the output only when `condition` is true.
+     * Returns `{}` when false — spread the result at the call site.
+     *
+     * @example
+     * toArray() {
+     *   return {
+     *     id: this.resource.id,
+     *     ...this.mergeWhen(this.resource.isAdmin, {
+     *       permissions: this.resource.permissions,
+     *       lastLogin:   this.resource.lastLogin,
+     *     }),
+     *   }
+     * }
+     */
+    mergeWhen(condition, attributes) {
+        return condition ? attributes : {};
+    }
+    /** Create a `ResourceCollection` from an array of raw items using this resource class. */
+    static collection(items, meta) {
+        return new ResourceCollection(items.map(item => new this(item)), meta);
+    }
+    toJSON() {
+        const result = this.toArray();
+        if (result instanceof Promise) {
+            throw new Error('[RudderJS] JsonResource.toJSON() does not support async toArray(). Use toArray() directly.');
+        }
+        return result;
+    }
+}
+// ─── ResourceCollection ─────────────────────────────────────
+/**
+ * Wraps multiple `JsonResource` instances for collection responses.
+ *
+ * @example
+ * class UserResource extends JsonResource<User> { ... }
+ *
+ * // From a route handler:
+ * const collection = UserResource.collection(users)
+ * res.json(await collection.toResponse())
+ * // → { data: [...] }
+ *
+ * // With pagination metadata:
+ * const collection = UserResource.collection(users, { total: 100, page: 1, perPage: 15 })
+ * res.json(await collection.toResponse())
+ * // → { data: [...], meta: { total: 100, page: 1, perPage: 15 } }
+ */
+export class ResourceCollection {
+    items;
+    meta;
+    constructor(items, meta) {
+        this.items = items;
+        this.meta = meta;
+    }
+    static of(items, meta) {
+        return new ResourceCollection(items, meta);
+    }
+    async toArray(req) {
+        return Promise.all(this.items.map(item => item.toArray(req)));
+    }
+    async toResponse(req) {
+        const data = await this.toArray(req);
+        return this.meta !== undefined ? { data, meta: this.meta } : { data };
+    }
+}
+//# sourceMappingURL=resource.js.map

package/dist/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAE/D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAgB,YAAY;IACD;IAA/B,YAA+B,QAAW;QAAX,aAAQ,GAAR,QAAQ,CAAG;IAAG,CAAC;IAgBpC,IAAI,CAAI,SAAkB,EAAE,KAAQ,EAAE,QAAY;QAC1D,OAAO,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAA;IACrC,CAAC;IAED;;;OAGG;IACO,WAAW,CACnB,KAA2B,EAC3B,IAAoC,EACpC,QAAY;QAEZ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,OAAO,IAAI,KAAK,UAAU;gBAC/B,CAAC,CAAE,IAAiC,CAAC,KAAuB,CAAC;gBAC7D,CAAC,CAAC,IAAI,CAAA;QACV,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IASS,UAAU,CAAI,QAAgB,EAAE,KAAS,EAAE,QAAY;QAC/D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAmC,CAAA;QACpD,IAAI,QAAQ,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;YACnD,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAM,CAAA;QACzD,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACO,SAAS,CAAC,SAAkB,EAAE,UAAmC;QACzE,OAAO,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAA;IACpC,CAAC;IAED,0FAA0F;IAC1F,MAAM,CAAC,UAAU,CAEf,KAAU,EACV,IAA8B;QAE9B,OAAO,IAAI,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IACxE,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;QAC7B,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAA;QACH,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,+DAA+D;AAE/D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,kBAAkB;IAEV;IACA;IAFnB,YACmB,KAAwB,EACxB,IAA8B;QAD9B,UAAK,GAAL,KAAK,CAAmB;QACxB,SAAI,GAAJ,IAAI,CAA0B;IAC9C,CAAC;IAEJ,MAAM,CAAC,EAAE,CACP,KAAwB,EACxB,IAA8B;QAE9B,OAAO,IAAI,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC5C,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAa;QACzB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAa;QAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACpC,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAA;IACvE,CAAC;CACF"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@rudderjs/orm",
+  "version": "0.0.6",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rudderjs/rudder",
+    "directory": "packages/orm"
+  },
+  "type": "module",
+  "files": [
+    "dist",
+    "boost"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@rudderjs/contracts": "0.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.4.0"
+  },
+  "author": "Suleiman Shahbari",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src",
+    "test": "tsc -p tsconfig.test.json && node --test dist-test/index.test.js; EXIT=$?; rm -rf dist-test; exit $EXIT",
+    "clean": "rm -rf dist"
+  }
+}