@managemint-solutions/entities 1.17.0 → 1.19.0

package/dist/feature-flags/index.d.ts

@@ -0,0 +1,27 @@
+import type { ConfigEntity } from '../configs';
+/**
+ * The row of `public.configs` that holds the portal's feature flags. Scott creates and edits
+ * it in Supabase Studio; the api reads it by this name and caches the value for a day.
+ */
+export declare const FEATURE_FLAGS_CONFIG_NAME = "portal_feature_flags";
+/**
+ * The Redis entry the api writes the flags to, and the portal reads first - the same
+ * entry, so one write serves both. Bump the version when the wire shape changes; old
+ * entries simply stop matching.
+ */
+export declare const FEATURE_FLAGS_CACHE_VERSION = "v1";
+export declare const FEATURE_FLAGS_CACHE_KEY = "config:v1:portal_feature_flags";
+/**
+ * One flag's rule: `true` for everyone, `false` for no one, or on only for the listed
+ * emails. Anything else - a missing flag, a malformed rule - is read as off by the portal.
+ */
+export type FeatureFlagRule = boolean | {
+    emails: string[];
+};
+/** The `value` of the flags row: one rule per flag, keyed by the flag's name. */
+export type FeatureFlags = Record<string, FeatureFlagRule>;
+/** The flags row itself: a config whose name is fixed and whose value is the flag map. */
+export interface FeatureFlagsConfig extends ConfigEntity {
+    name: typeof FEATURE_FLAGS_CONFIG_NAME;
+    value: FeatureFlags;
+}

package/dist/feature-flags/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FEATURE_FLAGS_CACHE_KEY = exports.FEATURE_FLAGS_CACHE_VERSION = exports.FEATURE_FLAGS_CONFIG_NAME = void 0;
+/**
+ * The row of `public.configs` that holds the portal's feature flags. Scott creates and edits
+ * it in Supabase Studio; the api reads it by this name and caches the value for a day.
+ */
+exports.FEATURE_FLAGS_CONFIG_NAME = 'portal_feature_flags';
+/**
+ * The Redis entry the api writes the flags to, and the portal reads first - the same
+ * entry, so one write serves both. Bump the version when the wire shape changes; old
+ * entries simply stop matching.
+ */
+exports.FEATURE_FLAGS_CACHE_VERSION = 'v1';
+exports.FEATURE_FLAGS_CACHE_KEY = `config:${exports.FEATURE_FLAGS_CACHE_VERSION}:${exports.FEATURE_FLAGS_CONFIG_NAME}`;

package/dist/users/cache/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * The contract for the portal's edge cache of each member's own `GET /users/me`.
  *
- * The portal owns the cache (Vercel Runtime Cache, one entry per member, written on a
- * miss); the api never reads it and only expires tags after a write. Both sides import
+ * The portal owns the cache (Upstash Redis through the sdk cache subpath, one entry per
+ * member, written on a miss); the api never reads it and only invalidates tags after a write. Both sides import
  * these so a change to the shape or the tagging is one edit.
  */
 /** Bump when the LoggedInUser wire shape changes; old entries simply stop matching. */

package/dist/users/cache/index.js

@@ -2,8 +2,8 @@
 /**
  * The contract for the portal's edge cache of each member's own `GET /users/me`.
  *
- * The portal owns the cache (Vercel Runtime Cache, one entry per member, written on a
- * miss); the api never reads it and only expires tags after a write. Both sides import
+ * The portal owns the cache (Upstash Redis through the sdk cache subpath, one entry per
+ * member, written on a miss); the api never reads it and only invalidates tags after a write. Both sides import
  * these so a change to the shape or the tagging is one edit.
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {