@entifix/rest 0.8.0 → 0.9.0

package/README.md

@@ -27,14 +27,18 @@ const repository = Context.make(EntityRepositoryTag, {
   delete: buildEntityRestAdapterDelete(Book, options),
 });
 
+const counter = Context.make(EntityFacetCounterTag, {
+  count: buildEntityRestAdapterFacets(Book, options), // GET <entity>/$facets
+});
+
 const status = buildTransactionStatusReader(options); // a TransactionStatusReader
 ```
 
 ## Entry points
 
-| Import          | What it holds                                                                                                                                          |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `@entifix/rest` | `buildEntityRestAdapterGet` / `Load` / `Save` / `Delete`, `makeEntityMetadataSource`, `buildTransactionStatusReader`, `performHttpRequestThroughFetch` |
+| Import          | What it holds                                                                                                                                                     |
+| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `@entifix/rest` | `buildEntityRestAdapterGet` / `Load` / `Save` / `Delete` / `Facets`, `makeEntityMetadataSource`, `buildTransactionStatusReader`, `performHttpRequestThroughFetch` |
 
 ---
 

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/build-entity-rest-adapter-facets.d.ts

@@ -0,0 +1,11 @@
+import { type Entity, type EntityConstructor, type EntityFacetQuery } from '@entifix/core';
+import { Effect } from 'effect';
+import { BuildEntityRestOptions } from '../types.js';
+/**
+ * The `count` of an `EntityFacetCounter`, over a service's
+ * `GET <entity>/$facets` — the load adapter's sibling, on the same base URL and
+ * the same query protocol, so what this composes is what the service parses
+ * back. The caller binds it to the port, as it binds `load` to the repository.
+ */
+export declare const buildEntityRestAdapterFacets: <TEntity extends Entity>(entityConstructor: EntityConstructor<TEntity>, { uriConfig, configuration }: BuildEntityRestOptions) => <T extends Entity>(queries: readonly EntityFacetQuery<T>[]) => Effect.Effect<Readonly<Record<string, readonly import("@entifix/core").EntityFacetValue[]>>, import("@entifix/core").EntifixBuildError | import("@entifix/core").EntifixConnError, never>;
+//# sourceMappingURL=build-entity-rest-adapter-facets.d.ts.map

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/build-entity-rest-adapter-facets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-entity-rest-adapter-facets.d.ts","sourceRoot":"","sources":["../../../../src/adapters/entity-rest/build-entity-rest-adapter-facets/build-entity-rest-adapter-facets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,iBAAiB,EAEtB,KAAK,gBAAgB,EAItB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAIhC,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACtC,OAAO,SAAS,MAAM,EACrB,mBAAmB,iBAAiB,CAAC,OAAO,CAAC,EAC7C,8BAA8B,sBAAsB,MAErD,CAAC,SAAS,MAAM,EAAE,SAAS,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,8LAoBtD,CAAC"}

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/build-entity-rest-adapter-facets.js

@@ -0,0 +1,25 @@
+import { envelopeEntityName, readEntityFacetsEnvelope, serializeFacetQueryParams } from '@entifix/core';
+import { Effect } from 'effect';
+import { performHttpRequestThroughFetch } from '../../../clients/fetch/index.js';
+import { buildEntityRestAdapterMixins as adapterMixins } from '../build-entity-rest-adapter-mixins/index.js';
+/**
+ * The `count` of an `EntityFacetCounter`, over a service's
+ * `GET <entity>/$facets` — the load adapter's sibling, on the same base URL and
+ * the same query protocol, so what this composes is what the service parses
+ * back. The caller binds it to the port, as it binds `load` to the repository.
+ */ export const buildEntityRestAdapterFacets = (entityConstructor, { uriConfig, configuration })=>(queries)=>Effect.gen(function*() {
+            // Asking for nothing is answered without a round trip; the service
+            // would refuse an empty request.
+            if (queries.length === 0) return {};
+            const baseUrl = yield* adapterMixins.buildEntityBaseUrl(configuration, {
+                uriConfig
+            }, envelopeEntityName(entityConstructor));
+            const query = serializeFacetQueryParams(queries).toString();
+            const response = yield* performHttpRequestThroughFetch(adapterMixins.buildEntityRequest({
+                method: 'GET',
+                url: `${baseUrl}/$facets?${query}`
+            }));
+            return yield* readEntityFacetsEnvelope(entityConstructor, response.body);
+        });
+
+//# sourceMappingURL=build-entity-rest-adapter-facets.js.map

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/build-entity-rest-adapter-facets.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/adapters/entity-rest/build-entity-rest-adapter-facets/build-entity-rest-adapter-facets.ts"],"sourcesContent":["import {\n  type Entity,\n  type EntityConstructor,\n  type EntityFacetCounts,\n  type EntityFacetQuery,\n  envelopeEntityName,\n  readEntityFacetsEnvelope,\n  serializeFacetQueryParams,\n} from '@entifix/core';\nimport { Effect } from 'effect';\n\nimport { performHttpRequestThroughFetch } from '../../../clients/fetch/index.js';\nimport { buildEntityRestAdapterMixins as adapterMixins } from '../build-entity-rest-adapter-mixins/index.js';\nimport { BuildEntityRestOptions } from '../types.js';\n\n/**\n * The `count` of an `EntityFacetCounter`, over a service's\n * `GET <entity>/$facets` — the load adapter's sibling, on the same base URL and\n * the same query protocol, so what this composes is what the service parses\n * back. The caller binds it to the port, as it binds `load` to the repository.\n */\nexport const buildEntityRestAdapterFacets =\n  <TEntity extends Entity>(\n    entityConstructor: EntityConstructor<TEntity>,\n    { uriConfig, configuration }: BuildEntityRestOptions,\n  ) =>\n  <T extends Entity>(queries: readonly EntityFacetQuery<T>[]) =>\n    Effect.gen(function* () {\n      // Asking for nothing is answered without a round trip; the service\n      // would refuse an empty request.\n      if (queries.length === 0) return {} as EntityFacetCounts;\n\n      const baseUrl = yield* adapterMixins.buildEntityBaseUrl(\n        configuration,\n        { uriConfig },\n        envelopeEntityName(entityConstructor),\n      );\n\n      const query = serializeFacetQueryParams(queries).toString();\n      const response = yield* performHttpRequestThroughFetch(\n        adapterMixins.buildEntityRequest({\n          method: 'GET',\n          url: `${baseUrl}/$facets?${query}`,\n        }),\n      );\n      return yield* readEntityFacetsEnvelope(entityConstructor, response.body);\n    });\n"],"names":["envelopeEntityName","readEntityFacetsEnvelope","serializeFacetQueryParams","Effect","performHttpRequestThroughFetch","buildEntityRestAdapterMixins","adapterMixins","buildEntityRestAdapterFacets","entityConstructor","uriConfig","configuration","queries","gen","length","baseUrl","buildEntityBaseUrl","query","toString","response","buildEntityRequest","method","url","body"],"mappings":"AAAA,SAKEA,kBAAkB,EAClBC,wBAAwB,EACxBC,yBAAyB,QACpB,gBAAgB;AACvB,SAASC,MAAM,QAAQ,SAAS;AAEhC,SAASC,8BAA8B,QAAQ,kCAAkC;AACjF,SAASC,gCAAgCC,aAAa,QAAQ,+CAA+C;AAG7G;;;;;CAKC,GACD,OAAO,MAAMC,+BACX,CACEC,mBACA,EAAEC,SAAS,EAAEC,aAAa,EAA0B,GAEtD,CAAmBC,UACjBR,OAAOS,GAAG,CAAC;YACT,mEAAmE;YACnE,iCAAiC;YACjC,IAAID,QAAQE,MAAM,KAAK,GAAG,OAAO,CAAC;YAElC,MAAMC,UAAU,OAAOR,cAAcS,kBAAkB,CACrDL,eACA;gBAAED;YAAU,GACZT,mBAAmBQ;YAGrB,MAAMQ,QAAQd,0BAA0BS,SAASM,QAAQ;YACzD,MAAMC,WAAW,OAAOd,+BACtBE,cAAca,kBAAkB,CAAC;gBAC/BC,QAAQ;gBACRC,KAAK,GAAGP,QAAQ,SAAS,EAAEE,OAAO;YACpC;YAEF,OAAO,OAAOf,yBAAyBO,mBAAmBU,SAASI,IAAI;QACzE,GAAG"}

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/index.d.ts

@@ -0,0 +1,2 @@
+export * from './build-entity-rest-adapter-facets.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/adapters/entity-rest/build-entity-rest-adapter-facets/index.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAC"}

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/index.js

@@ -0,0 +1,3 @@
+export * from './build-entity-rest-adapter-facets.js';
+
+//# sourceMappingURL=index.js.map

package/dist/adapters/entity-rest/build-entity-rest-adapter-facets/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/adapters/entity-rest/build-entity-rest-adapter-facets/index.ts"],"sourcesContent":["export * from './build-entity-rest-adapter-facets.js';\n"],"names":[],"mappings":"AAAA,cAAc,wCAAwC"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './adapters/entity-metadata/make-entity-metadata-source/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-delete/index.js';
+export * from './adapters/entity-rest/build-entity-rest-adapter-facets/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-get/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-load/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-save/index.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iEAAiE,CAAC;AAChF,cAAc,kEAAkE,CAAC;AACjF,cAAc,+DAA+D,CAAC;AAC9E,cAAc,gEAAgE,CAAC;AAC/E,cAAc,gEAAgE,CAAC;AAC/E,cAAc,iCAAiC,CAAC;AAChD,cAAc,wEAAwE,CAAC;AACvF,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iCAAiC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iEAAiE,CAAC;AAChF,cAAc,kEAAkE,CAAC;AACjF,cAAc,kEAAkE,CAAC;AACjF,cAAc,+DAA+D,CAAC;AAC9E,cAAc,gEAAgE,CAAC;AAC/E,cAAc,gEAAgE,CAAC;AAC/E,cAAc,iCAAiC,CAAC;AAChD,cAAc,wEAAwE,CAAC;AACvF,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iCAAiC,CAAC"}

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from './adapters/entity-metadata/make-entity-metadata-source/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-delete/index.js';
+export * from './adapters/entity-rest/build-entity-rest-adapter-facets/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-get/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-load/index.js';
 export * from './adapters/entity-rest/build-entity-rest-adapter-save/index.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './adapters/entity-metadata/make-entity-metadata-source/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-delete/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-get/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-load/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-save/index.js';\nexport * from './adapters/entity-rest/types.js';\nexport * from './adapters/transaction-status/build-transaction-status-reader/index.js';\nexport * from './clients/fetch/index.js';\nexport * from './clients/types.js';\nexport * from './configuration-client/index.js';\n"],"names":[],"mappings":"AAAA,cAAc,kEAAkE;AAChF,cAAc,mEAAmE;AACjF,cAAc,gEAAgE;AAC9E,cAAc,iEAAiE;AAC/E,cAAc,iEAAiE;AAC/E,cAAc,kCAAkC;AAChD,cAAc,yEAAyE;AACvF,cAAc,2BAA2B;AACzC,cAAc,qBAAqB;AACnC,cAAc,kCAAkC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './adapters/entity-metadata/make-entity-metadata-source/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-delete/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-facets/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-get/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-load/index.js';\nexport * from './adapters/entity-rest/build-entity-rest-adapter-save/index.js';\nexport * from './adapters/entity-rest/types.js';\nexport * from './adapters/transaction-status/build-transaction-status-reader/index.js';\nexport * from './clients/fetch/index.js';\nexport * from './clients/types.js';\nexport * from './configuration-client/index.js';\n"],"names":[],"mappings":"AAAA,cAAc,kEAAkE;AAChF,cAAc,mEAAmE;AACjF,cAAc,mEAAmE;AACjF,cAAc,gEAAgE;AAC9E,cAAc,iEAAiE;AAC/E,cAAc,iEAAiE;AAC/E,cAAc,kCAAkC;AAChD,cAAc,yEAAyE;AACvF,cAAc,2BAA2B;AACzC,cAAc,qBAAqB;AACnC,cAAc,kCAAkC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@entifix/rest",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "HTTP entity adapter for the browser: get, load, save and delete against an entifix service, plus served metadata and transaction status.",
   "license": "MIT",
   "repository": {
@@ -51,12 +51,12 @@
   },
   "dependencies": {
     "@swc/helpers": "0.5.23",
-    "@entifix/core": "0.8.0",
-    "@entifix/transactions": "0.8.0"
+    "@entifix/core": "0.9.0",
+    "@entifix/transactions": "0.9.0"
   },
   "devDependencies": {
     "effect": "4.0.5",
-    "@entifix/testing-unit": "0.8.0"
+    "@entifix/testing-unit": "0.9.0"
   },
   "peerDependencies": {
     "effect": "^4.0.5"