@epic-web/workshop-utils 5.20.4 → 5.22.0

package/dist/esm/epic-api.server.d.ts

@@ -17,13 +17,13 @@ declare function getEpicVideoInfo({ epicVideoEmbed, accessToken, request, timing
     muxPlaybackId: string;
     statusCode: number;
 } | {
-    type: "unknown";
     status: "error";
+    type: "unknown";
     statusText: string;
     statusCode: number;
 } | {
-    type: "region-restricted";
     status: "error";
+    type: "region-restricted";
     statusText: string;
     requestCountry: string;
     restrictedCountry: string;
@@ -143,9 +143,9 @@ declare const UserInfoSchema: z.ZodEffects<z.ZodObject<{
     }>>>;
 }, "strip", z.ZodTypeAny, {
     name: string | null;
-    image: string | null;
     id: string;
     email: string;
+    image: string | null;
     discordProfile?: {
         nick: string | null;
         user: {
@@ -157,9 +157,9 @@ declare const UserInfoSchema: z.ZodEffects<z.ZodObject<{
     } | null | undefined;
 }, {
     name: string | null;
-    image: string | null;
     id: string;
     email: string;
+    image: string | null;
     discordProfile?: {
         nick: string | null;
         user: {
@@ -173,9 +173,9 @@ declare const UserInfoSchema: z.ZodEffects<z.ZodObject<{
     imageUrlSmall: string | null;
     imageUrlLarge: string | null;
     name: string | null;
-    image: string | null;
     id: string;
     email: string;
+    image: string | null;
     discordProfile?: {
         nick: string | null;
         user: {
@@ -187,9 +187,9 @@ declare const UserInfoSchema: z.ZodEffects<z.ZodObject<{
     } | null | undefined;
 }, {
     name: string | null;
-    image: string | null;
     id: string;
     email: string;
+    image: string | null;
     discordProfile?: {
         nick: string | null;
         user: {
@@ -209,9 +209,9 @@ export declare function getUserInfo({ timings, request, forceFresh, }?: {
     imageUrlSmall: string | null;
     imageUrlLarge: string | null;
     name: string | null;
-    image: string | null;
     id: string;
     email: string;
+    image: string | null;
     discordProfile?: {
         nick: string | null;
         user: {

package/dist/esm/notifications.server.d.ts

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+declare const NotificationSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    message: z.ZodString;
+    link: z.ZodOptional<z.ZodString>;
+    type: z.ZodEnum<["info", "warning", "danger"]>;
+    products: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        host: z.ZodString;
+        slug: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        host: string;
+        slug?: string | undefined;
+    }, {
+        host: string;
+        slug?: string | undefined;
+    }>, "many">>;
+    expiresAt: z.ZodEffects<z.ZodNullable<z.ZodString>, Date | null, string | null>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    message: string;
+    type: "info" | "warning" | "danger";
+    id: string;
+    expiresAt: Date | null;
+    link?: string | undefined;
+    products?: {
+        host: string;
+        slug?: string | undefined;
+    }[] | undefined;
+}, {
+    title: string;
+    message: string;
+    type: "info" | "warning" | "danger";
+    id: string;
+    expiresAt: string | null;
+    link?: string | undefined;
+    products?: {
+        host: string;
+        slug?: string | undefined;
+    }[] | undefined;
+}>;
+export type Notification = z.infer<typeof NotificationSchema>;
+export declare function getUnmutedNotifications(): Promise<{
+    title: string;
+    message: string;
+    type: "info" | "warning" | "danger";
+    id: string;
+    expiresAt: Date | null;
+    link?: string | undefined;
+    products?: {
+        host: string;
+        slug?: string | undefined;
+    }[] | undefined;
+}[]>;
+export {};
+//# sourceMappingURL=notifications.server.d.ts.map

package/dist/esm/notifications.server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.server.d.ts","sourceRoot":"","sources":["../../src/notifications.server.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkBtB,CAAA;AAEF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAsB7D,wBAAsB,uBAAuB;;;;;;;;;;;KAgC5C"}

package/dist/esm/notifications.server.js

@@ -0,0 +1,65 @@
+import json5 from 'json5';
+import { z } from 'zod';
+import { cachified, notificationsCache } from './cache.server.js';
+import { getWorkshopConfig } from './config.server.js';
+import { getMutedNotifications } from './db.server.js';
+const NotificationSchema = z.object({
+    id: z.string(),
+    title: z.string(),
+    message: z.string(),
+    link: z.string().optional(),
+    type: z.enum(['info', 'warning', 'danger']),
+    products: z
+        .array(z.object({
+        host: z.string(),
+        slug: z.string().optional(),
+    }))
+        .optional(),
+    expiresAt: z
+        .string()
+        .nullable()
+        .transform((val) => (val ? new Date(val) : null)),
+});
+async function getRemoteNotifications() {
+    return cachified({
+        key: 'notifications',
+        cache: notificationsCache,
+        ttl: 1000 * 60 * 60 * 6,
+        swr: 1000 * 60 * 60 * 24,
+        offlineFallbackValue: [],
+        async getFreshValue() {
+            const URL = 'https://gist.github.com/kentcdodds/c3aaa5141f591cdbb0e6bfcacd361f39';
+            const filename = 'notifications.json5';
+            const response = await fetch(`${URL}/raw/${filename}`);
+            const text = await response.text();
+            const json = json5.parse(text);
+            return NotificationSchema.array().parse(json);
+        },
+    }).catch(() => []);
+}
+export async function getUnmutedNotifications() {
+    if (ENV.EPICSHOP_DEPLOYED)
+        return [];
+    const remoteNotifications = await getRemoteNotifications();
+    const config = getWorkshopConfig();
+    const notificationsToShow = remoteNotifications
+        .filter((n) => {
+        if (n.expiresAt && n.expiresAt < new Date()) {
+            return false;
+        }
+        return true;
+    })
+        .filter((n) => {
+        if (!n.products)
+            return true;
+        return n.products.some((p) => {
+            return (p.host === config.product.host &&
+                (p.slug ? p.slug === config.product.slug : true));
+        });
+    })
+        .concat(config.notifications);
+    const muted = await getMutedNotifications();
+    const visibleNotifications = notificationsToShow.filter((n) => !muted.includes(n.id));
+    return visibleNotifications;
+}
+//# sourceMappingURL=notifications.server.js.map

package/dist/esm/notifications.server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.server.js","sourceRoot":"","sources":["../../src/notifications.server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAEtD,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC3C,QAAQ,EAAE,CAAC;SACT,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC3B,CAAC,CACF;SACA,QAAQ,EAAE;IACZ,SAAS,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;CAClD,CAAC,CAAA;AAIF,KAAK,UAAU,sBAAsB;IACpC,OAAO,SAAS,CAAC;QAChB,GAAG,EAAE,eAAe;QACpB,KAAK,EAAE,kBAAkB;QACzB,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;QACvB,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;QACxB,oBAAoB,EAAE,EAAE;QACxB,KAAK,CAAC,aAAa;YAClB,MAAM,GAAG,GACR,qEAAqE,CAAA;YACtE,MAAM,QAAQ,GAAG,qBAAqB,CAAA;YACtC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,QAAQ,QAAQ,EAAE,CAAC,CAAA;YACtD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YAClC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAE9B,OAAO,kBAAkB,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC9C,CAAC;KACD,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAA;AACnB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB;IAC5C,IAAI,GAAG,CAAC,iBAAiB;QAAE,OAAO,EAAE,CAAA;IAEpC,MAAM,mBAAmB,GAAG,MAAM,sBAAsB,EAAE,CAAA;IAE1D,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAA;IAElC,MAAM,mBAAmB,GAAG,mBAAmB;SAC7C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACb,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAA;QACb,CAAC;QACD,OAAO,IAAI,CAAA;IACZ,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACb,IAAI,CAAC,CAAC,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;QAC5B,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YAC5B,OAAO,CACN,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI;gBAC9B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAChD,CAAA;QACF,CAAC,CAAC,CAAA;IACH,CAAC,CAAC;SACD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;IAE9B,MAAM,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAA;IAE3C,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,MAAM,CACtD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5B,CAAA;IAED,OAAO,oBAAoB,CAAA;AAC5B,CAAC","sourcesContent":["import json5 from 'json5'\nimport { z } from 'zod'\nimport { cachified, notificationsCache } from './cache.server.js'\nimport { getWorkshopConfig } from './config.server.js'\nimport { getMutedNotifications } from './db.server.js'\n\nconst NotificationSchema = z.object({\n\tid: z.string(),\n\ttitle: z.string(),\n\tmessage: z.string(),\n\tlink: z.string().optional(),\n\ttype: z.enum(['info', 'warning', 'danger']),\n\tproducts: z\n\t\t.array(\n\t\t\tz.object({\n\t\t\t\thost: z.string(),\n\t\t\t\tslug: z.string().optional(),\n\t\t\t}),\n\t\t)\n\t\t.optional(),\n\texpiresAt: z\n\t\t.string()\n\t\t.nullable()\n\t\t.transform((val) => (val ? new Date(val) : null)),\n})\n\nexport type Notification = z.infer<typeof NotificationSchema>\n\nasync function getRemoteNotifications() {\n\treturn cachified({\n\t\tkey: 'notifications',\n\t\tcache: notificationsCache,\n\t\tttl: 1000 * 60 * 60 * 6,\n\t\tswr: 1000 * 60 * 60 * 24,\n\t\tofflineFallbackValue: [],\n\t\tasync getFreshValue() {\n\t\t\tconst URL =\n\t\t\t\t'https://gist.github.com/kentcdodds/c3aaa5141f591cdbb0e6bfcacd361f39'\n\t\t\tconst filename = 'notifications.json5'\n\t\t\tconst response = await fetch(`${URL}/raw/${filename}`)\n\t\t\tconst text = await response.text()\n\t\t\tconst json = json5.parse(text)\n\n\t\t\treturn NotificationSchema.array().parse(json)\n\t\t},\n\t}).catch(() => [])\n}\n\nexport async function getUnmutedNotifications() {\n\tif (ENV.EPICSHOP_DEPLOYED) return []\n\n\tconst remoteNotifications = await getRemoteNotifications()\n\n\tconst config = getWorkshopConfig()\n\n\tconst notificationsToShow = remoteNotifications\n\t\t.filter((n) => {\n\t\t\tif (n.expiresAt && n.expiresAt < new Date()) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\treturn true\n\t\t})\n\t\t.filter((n) => {\n\t\t\tif (!n.products) return true\n\t\t\treturn n.products.some((p) => {\n\t\t\t\treturn (\n\t\t\t\t\tp.host === config.product.host &&\n\t\t\t\t\t(p.slug ? p.slug === config.product.slug : true)\n\t\t\t\t)\n\t\t\t})\n\t\t})\n\t\t.concat(config.notifications)\n\n\tconst muted = await getMutedNotifications()\n\n\tconst visibleNotifications = notificationsToShow.filter(\n\t\t(n) => !muted.includes(n.id),\n\t)\n\n\treturn visibleNotifications\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epic-web/workshop-utils",
-  "version": "5.20.4",
+  "version": "5.22.0",
   "publishConfig": {
     "access": "public"
   },
@@ -26,6 +26,7 @@
       "./git.server": "./src/git.server.ts",
       "./iframe-sync": "./src/iframe-sync.ts",
       "./playwright.server": "./src/playwright.server.ts",
+      "./notifications.server": "./src/notifications.server.ts",
       "./process-manager.server": "./src/process-manager.server.ts",
       "./test": "./src/test.ts",
       "./utils.server": "./src/utils.server.ts",
@@ -118,6 +119,12 @@
         "default": "./dist/esm/playwright.server.js"
       }
     },
+    "./notifications.server": {
+      "import": {
+        "types": "./dist/esm/notifications.server.d.ts",
+        "default": "./dist/esm/notifications.server.js"
+      }
+    },
     "./process-manager.server": {
       "import": {
         "types": "./dist/esm/process-manager.server.d.ts",
@@ -181,6 +188,7 @@
     "fs-extra": "^11.2.0",
     "globby": "^14.0.2",
     "ignore": "^5.3.2",
+    "json5": "^2.2.3",
     "lru-cache": "^11.0.1",
     "md5-hex": "^5.0.0",
     "mdast-util-mdx-jsx": "^3.1.3",