@devvit/shared-types 0.12.0-next-2025-04-30-2e2a14dbe.0 → 0.12.0-next-2025-08-12-20-19-11-8d352335b.0

package/package.json

@@ -1,37 +1,45 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.12.0-next-2025-04-30-2e2a14dbe.0",
+  "version": "0.12.0-next-2025-08-12-20-19-11-8d352335b.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
     "url": "https://developers.reddit.com/"
   },
   "type": "module",
-  "main": "./index.js",
+  "exports": {
+    ".": "./index.js",
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "main": "./dist/index.js",
+  "files": [
+    "**"
+  ],
   "scripts": {
-    "build": "tsc && yarn postbuild:copy-payments-schema",
+    "build": "tsc && yarn postbuild:copy-schemas",
     "clean": "rm -rf .turbo coverage dist",
     "clobber": "yarn clean && rm -rf node_modules",
     "dev": "tsc -w",
     "dev:build": "chokidar ./src --command 'yarn build && echo \"BUILD COMPLETE\"'",
     "lint": "redlint .",
     "lint:fix": "yarn lint --fix",
-    "postbuild:copy-payments-schema": "cp -a -f  ./src/payments/products.schema.json ./dist/payments",
+    "postbuild:copy-schemas": "cp -af src/schemas/*.json dist/schemas/",
     "prepublishOnly": "publish-package-json",
     "test": "yarn test:unit && yarn test:types",
     "test:types": "tsc --noEmit",
     "test:unit": "vitest run",
     "test:unit-with-coverage": "vitest run --coverage"
   },
-  "types": "./index.d.ts",
+  "types": "./dist/index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.12.0-next-2025-04-30-2e2a14dbe.0",
+    "@devvit/protos": "0.12.0-next-2025-08-12-20-19-11-8d352335b.0",
     "jsonschema": "1.4.1",
     "uuid": "9.0.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.12.0-next-2025-04-30-2e2a14dbe.0",
-    "@devvit/tsconfig": "0.12.0-next-2025-04-30-2e2a14dbe.0",
+    "@devvit/repo-tools": "0.12.0-next-2025-08-12-20-19-11-8d352335b.0",
+    "@devvit/tsconfig": "0.12.0-next-2025-08-12-20-19-11-8d352335b.0",
     "@types/redis-mock": "0.17.1",
     "@types/uuid": "9.0.0",
     "chokidar-cli": "3.0.0",
@@ -39,12 +47,9 @@
     "lit": "2.5.0",
     "redis": "4.6.6",
     "redis-mock": "0.56.3",
-    "typescript": "5.3.2",
+    "typescript": "5.8.3",
     "vitest": "1.6.1"
   },
-  "publishConfig": {
-    "directory": "dist"
-  },
   "source": "./src/index.ts",
-  "gitHead": "f5c8aebe82ecd7cdf07201d3f3b4f022c86016d9"
+  "gitHead": "7d371722329289fb5dc280a264636ef8c8ea1863"
 }

package/richtext/index.d.ts

@@ -0,0 +1,6 @@
+export type * from './containers.js';
+export type * from './contexts.js';
+export type * from './options.js';
+export * from './RichTextBuilder.js';
+export type * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/richtext/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/richtext/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,iBAAiB,CAAC;AACrC,mBAAmB,eAAe,CAAC;AAEnC,mBAAmB,cAAc,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,YAAY,CAAC"}

package/richtext/index.js

@@ -0,0 +1 @@
+export * from './RichTextBuilder.js';

package/schemas/config-file.v1.d.ts

@@ -0,0 +1,272 @@
+/**
+ * Warning: this file is not isomorphic. Do not functionally import this file
+ * from client code.
+ */
+import { Scope } from '@devvit/protos';
+import type { JsonObject, JsonValue } from '../json.js';
+/**
+ * devvit.json with defaults. See config-file.v1.json schema. Schema is assumed
+ * to be v1.
+ */
+export type AppConfig = {
+    schema: 'v1';
+    name: string;
+    media?: {
+        dir: string;
+    };
+    permissions: AppPermissionConfig;
+    post?: AppPostConfig;
+    server?: AppServerConfig;
+    triggers?: AppTriggersConfig;
+    blocks?: AppBlocksConfig;
+    dev?: AppDevConfig;
+    menu?: AppMenuConfig;
+    scheduler?: AppSchedulerConfig;
+    settings?: AppSettingsConfig;
+    forms?: AppFormsConfig;
+    marketingAssets?: AppMarketingAssetsConfig;
+    /** The original config as parsed. Used for writebacks. */
+    json: AppConfigJson;
+};
+export type AppBlocksConfig = {
+    entry: string;
+};
+/** Describes plugin usage. */
+export type AppPermissionConfig = {
+    http: {
+        enable: boolean;
+        domains: string[];
+    };
+    media: boolean;
+    menu: boolean;
+    payments: boolean;
+    realtime: boolean;
+    redis: boolean;
+    reddit: {
+        enable: boolean;
+        scope: AppScopeConfig;
+        asUser: Scope[];
+    };
+    settings: boolean;
+    triggers: boolean;
+};
+export type AppPostConfig = {
+    dir: string;
+    entrypoints: AppPostEntrypointsConfig;
+};
+export type AppPostEntrypointsConfig = {
+    [name: string]: AppPostEntrypointConfig;
+    default: AppPostEntrypointConfig;
+};
+export type AppPostEntrypointConfig = {
+    entry: string;
+    name: string;
+    height: AppPostHeightConfig;
+};
+export type AppPostHeightConfig = 'regular' | 'tall';
+export type AppScopeConfig = 'user' | 'moderator';
+export type AppServerConfig = {
+    dir: string;
+    entry: string;
+};
+/**
+ * Keys are assumed to have the format of `on${keyof TriggerEventType}` in
+ * blocks.template.tsx.
+ */
+export type AppTriggersConfig = {
+    onAppInstall?: string;
+    onAppUpgrade?: string;
+    onAutomoderatorFilterComment?: string;
+    onAutomoderatorFilterPost?: string;
+    onCommentCreate?: string;
+    onCommentDelete?: string;
+    onCommentReport?: string;
+    onCommentSubmit?: string;
+    onCommentUpdate?: string;
+    onModAction?: string;
+    onModMail?: string;
+    onPostCreate?: string;
+    onPostDelete?: string;
+    onPostFlairUpdate?: string;
+    onPostNsfwUpdate?: string;
+    onPostReport?: string;
+    onPostSpoilerUpdate?: string;
+    onPostSubmit?: string;
+    onPostUpdate?: string;
+};
+export type AppMenuUserTypeConfig = 'moderator' | 'user';
+export type AppMenuLocationConfig = 'comment' | 'post' | 'subreddit';
+export type AppMenuPostFilterConfig = 'currentApp' | 'none';
+export type AppMenuItemConfig = {
+    label: string;
+    description: string;
+    forUserType: AppMenuUserTypeConfig;
+    location: AppMenuLocationConfig[];
+    endpoint: string;
+    postFilter: AppMenuPostFilterConfig;
+};
+export type AppMenuConfig = {
+    items: AppMenuItemConfig[];
+};
+export type AppFormsConfig = {
+    [formName: string]: string;
+};
+export type AppMarketingAssetsConfig = {
+    icon?: string;
+};
+export type AppDevConfig = {
+    subreddit?: string;
+};
+export type AppSchedulerConfig = {
+    tasks: {
+        [name: string]: AppSchedulerTaskConfig;
+    };
+};
+export type AppSchedulerTaskConfig = {
+    endpoint: string;
+    cron?: string;
+    data?: JsonObject;
+};
+export type AppSettingsConfig = {
+    global?: {
+        [name: string]: AppSettingConfig;
+    };
+    subreddit?: {
+        [name: string]: AppSettingConfig;
+    };
+};
+export type AppSettingConfig = AppStringSettingConfig | AppParagraphSettingConfig | AppNumberSettingConfig | AppBooleanSettingConfig | AppSelectSettingConfig | AppMultiSelectSettingConfig;
+export type AppBaseSettingConfig = {
+    name: string;
+    label: string;
+    helpText?: string;
+    validationEndpoint?: string;
+};
+export type AppStringSettingConfig = AppBaseSettingConfig & {
+    type: 'string';
+    placeholder?: string;
+    defaultValue?: string;
+    isSecret?: boolean;
+};
+export type AppParagraphSettingConfig = AppBaseSettingConfig & {
+    type: 'paragraph';
+    placeholder?: string;
+    defaultValue?: string;
+};
+export type AppNumberSettingConfig = AppBaseSettingConfig & {
+    type: 'number';
+    defaultValue?: number;
+};
+export type AppBooleanSettingConfig = AppBaseSettingConfig & {
+    type: 'boolean';
+    defaultValue?: boolean;
+};
+export type AppSelectSettingConfig = AppBaseSettingConfig & {
+    type: 'select';
+    options: Array<{
+        label: string;
+        value: string;
+    }>;
+    defaultValue?: string;
+};
+export type AppMultiSelectSettingConfig = AppBaseSettingConfig & {
+    type: 'multiSelect';
+    options: Array<{
+        label: string;
+        value: string;
+    }>;
+    defaultValue?: string[];
+};
+/**
+ * https://transform.tools/json-schema-to-typescript
+ * @internal
+ */
+export type AppConfigJson = {
+    $schema?: string;
+    name: string;
+    media?: {
+        dir?: string;
+    };
+    permissions?: {
+        http?: {
+            enable?: boolean;
+            domains?: string[];
+        };
+        media?: boolean;
+        payments?: boolean;
+        realtime?: boolean;
+        redis?: boolean;
+        reddit?: {
+            enable?: boolean;
+            scope?: AppScopeConfig;
+            asUser?: string[];
+        };
+    };
+    post?: {
+        dir?: string;
+        entrypoints?: {
+            [name: string]: AppPostEntrypointConfigJson;
+        } & {
+            default: Partial<AppPostEntrypointConfigJson>;
+        };
+    };
+    server?: {
+        dir?: string;
+        entry?: string;
+    };
+    triggers?: AppTriggersConfig;
+    blocks?: {
+        entry?: string;
+        menu?: {
+            enable?: boolean;
+        };
+        settings?: {
+            enable?: boolean;
+        };
+    };
+    menu?: {
+        items?: {
+            label: string;
+            description?: string;
+            forUserType: AppMenuUserTypeConfig;
+            location: AppMenuLocationConfig | AppMenuLocationConfig[];
+            endpoint: string;
+            postFilter: AppMenuPostFilterConfig;
+        }[];
+    };
+    forms?: {
+        [formName: string]: string;
+    };
+    dev?: {
+        subreddit?: string;
+    };
+    scheduler?: AppSchedulerConfigJson;
+    settings?: {
+        global?: {
+            [name: string]: AppSettingConfigJson;
+        };
+        subreddit?: {
+            [name: string]: AppSettingConfigJson;
+        };
+    };
+    marketingAssets?: {
+        icon?: string;
+    };
+    /** User data. */
+    [key: string]: JsonValue;
+};
+export type AppPostEntrypointConfigJson = {
+    entry: string;
+    height?: AppPostHeightConfig;
+};
+export type AppSchedulerConfigJson = {
+    tasks: {
+        [name: string]: AppSchedulerTaskConfig | string;
+    };
+};
+export type AppSettingConfigJson = Omit<AppStringSettingConfig, 'name'> | Omit<AppParagraphSettingConfig, 'name'> | Omit<AppNumberSettingConfig, 'name'> | Omit<AppBooleanSettingConfig, 'name'> | Omit<AppSelectSettingConfig, 'name'> | Omit<AppMultiSelectSettingConfig, 'name'>;
+export declare function parseAppConfig(str: string, allowUninitializedConfig: boolean): AppConfig;
+export declare function parseAppConfigJson(json: JsonValue, allowUninitializedConfig: boolean): AppConfig;
+/** @internal */
+export declare function validate(config: Readonly<AppConfig>): void;
+//# sourceMappingURL=config-file.v1.d.ts.map

package/schemas/config-file.v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-file.v1.d.ts","sourceRoot":"","sources":["../../src/schemas/config-file.v1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAiB,MAAM,gBAAgB,CAAC;AAGtD,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAIxD;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,EAAE,IAAI,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACxB,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,eAAe,CAAC,EAAE,wBAAwB,CAAC;IAC3C,0DAA0D;IAC1D,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAChD,8BAA8B;AAC9B,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAC7C,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,cAAc,CAAC;QAAC,MAAM,EAAE,KAAK,EAAE,CAAA;KAAE,CAAC;IACpE,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,aAAa,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,wBAAwB,CAAA;CAAE,CAAC;AACnF,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IACxC,OAAO,EAAE,uBAAuB,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,MAAM,CAAC;AACrD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,WAAW,CAAC;AAClD,MAAM,MAAM,eAAe,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG,WAAW,GAAG,MAAM,CAAC;AACzD,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,CAAC;AACrE,MAAM,MAAM,uBAAuB,GAAG,YAAY,GAAG,MAAM,CAAC;AAC5D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,qBAAqB,CAAC;IACnC,QAAQ,EAAE,qBAAqB,EAAE,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,uBAAuB,CAAC;CACrC,CAAC;AACF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,iBAAiB,EAAE,CAAC;CAC5B,CAAC;AACF,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AACF,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAA;KAAE,CAAC;CACnD,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;IAC9C,SAAS,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CAClD,CAAC;AACF,MAAM,MAAM,gBAAgB,GACxB,sBAAsB,GACtB,yBAAyB,GACzB,sBAAsB,GACtB,uBAAuB,GACvB,sBAAsB,GACtB,2BAA2B,CAAC;AAEhC,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D,IAAI,EAAE,QAAQ,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,GAAG;IAC7D,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D,IAAI,EAAE,QAAQ,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,GAAG;IAC3D,IAAI,EAAE,SAAS,CAAC;IAChB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,GAAG;IAC/D,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzB,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE;YAAE,MAAM,CAAC,EAAE,OAAO,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;QAChD,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,CAAC,EAAE;YAAE,MAAM,CAAC,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,cAAc,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;KAC1E,CAAC;IACF,IAAI,CAAC,EAAE;QACL,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE;YAAE,CAAC,IAAI,EAAE,MAAM,GAAG,2BAA2B,CAAA;SAAE,GAAG;YAC9D,OAAO,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;SAC/C,CAAC;KACH,CAAC;IACF,MAAM,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE;YAAE,MAAM,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC;QAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KAAE,CAAC;IAC1F,IAAI,CAAC,EAAE;QACL,KAAK,CAAC,EAAE;YACN,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,WAAW,EAAE,qBAAqB,CAAC;YACnC,QAAQ,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,CAAC;YAC1D,QAAQ,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE,uBAAuB,CAAC;SACrC,EAAE,CAAC;KACL,CAAC;IACF,KAAK,CAAC,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACvC,GAAG,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7B,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,QAAQ,CAAC,EAAE;QACT,MAAM,CAAC,EAAE;YAAE,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,CAAA;SAAE,CAAC;QAClD,SAAS,CAAC,EAAE;YAAE,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,CAAA;SAAE,CAAC;KACtD,CAAC;IACF,eAAe,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,iBAAiB;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,GAAG,MAAM,CAAA;KAAE,CAAC;CAC5D,CAAC;AACF,MAAM,MAAM,oBAAoB,GAC5B,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,GACpC,IAAI,CAAC,yBAAyB,EAAE,MAAM,CAAC,GACvC,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,GACpC,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,GACrC,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,GACpC,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;AAE9C,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,wBAAwB,EAAE,OAAO,GAAG,SAAS,CAWxF;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,wBAAwB,EAAE,OAAO,GAAG,SAAS,CAkChG;AAyMD,gBAAgB;AAChB,wBAAgB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,IAAI,CAiC1D"}

package/schemas/config-file.v1.js

@@ -0,0 +1,254 @@
+/**
+ * Warning: this file is not isomorphic. Do not functionally import this file
+ * from client code.
+ */
+import { Scope, scopeFromJSON } from '@devvit/protos';
+import jsonschema from 'jsonschema/lib/index.js';
+import schema from './config-file.v1.json' with { type: 'json' };
+import { defaultPostEntry, UNINITIALIZED_APP_NAME } from './constants.js';
+export function parseAppConfig(str, allowUninitializedConfig) {
+    if (!str)
+        throw Error('config is empty');
+    let json;
+    try {
+        json = JSON.parse(str);
+    }
+    catch (err) {
+        throw Error(`cannot parse config JSON`, { cause: err });
+    }
+    return parseAppConfigJson(json, allowUninitializedConfig);
+}
+export function parseAppConfigJson(json, allowUninitializedConfig) {
+    const unitializedSchema = {
+        ...schema,
+        properties: {
+            ...schema.properties,
+            name: {
+                ...schema.properties.name,
+                pattern: `${schema.properties.name.pattern}|^${UNINITIALIZED_APP_NAME}$`,
+            },
+        },
+    };
+    const ret = jsonschema.validate(json, allowUninitializedConfig ? unitializedSchema : schema);
+    if (!ret.valid)
+        throw new Error(ret.errors
+            .map((err) => {
+            if (!err.path.length && err.name === 'anyOf' && /\[subschema \d\]/.test(err.stack))
+                return 'config requires property "post", "server", or "blocks".';
+            if (err.stack.includes('name does not match pattern'))
+                return err.stack
+                    .replaceAll('instance.', '')
+                    .concat('. Try running `npm create devvit` to fix your app name.');
+            return err.stack.replaceAll('instance.', '').replaceAll('instance', 'config');
+        })
+            .join('; '));
+    const instance = ret.instance;
+    if (instance.$schema != null && instance.$schema !== schema.$id)
+        console.warn(`Unknown schema "${instance.$schema}".`);
+    return AppConfig(instance);
+}
+// jsonschema only supports rewrite hooks but it's easier to update defaults
+// after validation when the entire config is known. Eg,
+// `config.permissions.http` has a different default if `config.server` is set.
+//
+// Ajv supports some default application but it seems like some features are
+// still missing (https://github.com/ajv-validator/ajv/issues/1158). Even if the
+// feature is added, we need the defaults in the properties for documentation
+// and the same dynamic default adjustments as above are required.
+function AppConfig(json) {
+    const partial = {
+        schema: 'v1', // Always assume v1 since that's all that's supported.
+        name: json.name,
+        json,
+    };
+    if (json.media)
+        partial.media = {
+            dir: json.media.dir ?? schema.properties.media.properties.dir.default,
+        };
+    if (json.post)
+        partial.post = AppPostConfig(json);
+    if (json.server)
+        partial.server = {
+            dir: json.server.dir ?? schema.properties.server.properties.dir.default,
+            entry: json.server.entry ?? schema.properties.server.properties.entry.default,
+        };
+    if (json.triggers && Object.keys(json.triggers).length)
+        partial.triggers = json.triggers;
+    if (json.blocks)
+        partial.blocks = AppBlocksConfig(json);
+    if (json.menu)
+        partial.menu = AppMenuConfig(json);
+    if (json.scheduler)
+        partial.scheduler = AppSchedulerConfig(json);
+    if (json.settings)
+        partial.settings = AppSettingsConfig(json);
+    if (json.forms)
+        partial.forms = json.forms;
+    if (json.marketingAssets)
+        partial.marketingAssets = json.marketingAssets;
+    if (json.dev) {
+        partial.dev = {};
+        if (json.dev.subreddit)
+            partial.dev.subreddit = json.dev.subreddit;
+    }
+    const config = { ...partial, permissions: AppPermissionConfig(json, partial) };
+    validate(config);
+    // Deep copy so schema is not mutated.
+    return structuredClone(config);
+}
+function AppSchedulerConfig(json) {
+    const appSchedulerConfig = { tasks: {} };
+    if (json.scheduler?.tasks) {
+        for (const [name, taskSpec] of Object.entries(json.scheduler.tasks)) {
+            if (typeof taskSpec === 'string') {
+                // If the task is a string, it is an endpoint.
+                appSchedulerConfig.tasks[name] = {
+                    endpoint: taskSpec,
+                };
+            }
+            else {
+                // Otherwise, it is an object with an endpoint and optionally a cron.
+                appSchedulerConfig.tasks[name] = {
+                    endpoint: taskSpec.endpoint,
+                    ...(taskSpec.cron
+                        ? { cron: taskSpec.cron, ...(taskSpec.data ? { data: taskSpec.data } : {}) }
+                        : {}),
+                };
+            }
+        }
+    }
+    return appSchedulerConfig;
+}
+function AppPermissionConfig(json, partial) {
+    return {
+        http: {
+            enable: json.permissions?.http?.enable ??
+                (json.permissions?.http
+                    ? schema.properties.permissions.properties.http.properties.enable.default
+                    : false),
+            domains: json.permissions?.http?.domains ??
+                schema.properties.permissions.properties.http.properties.domains.default,
+        },
+        media: json.permissions?.media ?? schema.properties.permissions.properties.media.default,
+        menu: !!partial.menu?.items?.length ||
+            (json.blocks?.menu?.enable ??
+                (json.blocks ? schema.properties.blocks.properties.menu.properties.enable.default : false)),
+        payments: json.permissions?.payments ?? schema.properties.permissions.properties.payments.default,
+        realtime: json.permissions?.realtime ?? schema.properties.permissions.properties.realtime.default,
+        redis: json.permissions?.redis ??
+            // Menu items call addCSRFTokenToContext() which uses Redis.
+            (partial.menu?.items?.length
+                ? true
+                : partial.post
+                    ? true
+                    : schema.properties.permissions.properties.redis.default),
+        reddit: {
+            enable: json.permissions?.reddit?.enable ??
+                (partial.post
+                    ? true
+                    : json.permissions?.reddit
+                        ? schema.properties.permissions.properties.reddit.properties.enable.default
+                        : false),
+            scope: json.permissions?.reddit?.scope ??
+                schema.properties.permissions.properties.reddit.properties.scope
+                    .default,
+            asUser: json.permissions?.reddit?.asUser?.map((x) => scopeFromJSON(x)) ??
+                schema.properties.permissions.properties.reddit.properties.asUser.default,
+        },
+        settings: json.blocks?.settings?.enable ??
+            (json.blocks
+                ? schema.properties.blocks.properties.settings.properties.enable.default
+                : false),
+        triggers: !!partial.triggers,
+    };
+}
+function AppPostConfig(json) {
+    const dir = json.post?.dir ?? schema.properties.post.properties.dir.default;
+    const defaultHeight = schema.$defs.Entrypoint.properties.height.default;
+    const entrypoints = {
+        [defaultPostEntry]: {
+            name: defaultPostEntry,
+            entry: json.post?.entrypoints?.default.entry ??
+                schema.properties.post.properties.entrypoints.properties.default.properties.entry.default,
+            height: json.post?.entrypoints?.default.height ?? defaultHeight,
+        },
+    };
+    for (const [name, pt] of Object.entries(json.post?.entrypoints ?? {})) {
+        if (name !== defaultPostEntry)
+            entrypoints[name] = {
+                name,
+                entry: pt.entry,
+                height: pt.height ?? defaultHeight,
+            };
+    }
+    return {
+        dir,
+        entrypoints,
+    };
+}
+function AppBlocksConfig(json) {
+    return {
+        entry: json.blocks?.entry ?? schema.properties.blocks.properties.entry.default,
+    };
+}
+function AppMenuConfig(json) {
+    const items = [];
+    for (const item of json.menu?.items ?? []) {
+        items.push({
+            label: item.label,
+            description: item.description ?? '',
+            forUserType: item.forUserType ?? 'moderator',
+            postFilter: item.postFilter ?? 'none',
+            location: Array.isArray(item.location) ? item.location : [item.location],
+            endpoint: item.endpoint,
+        });
+    }
+    return { items };
+}
+function AppSettingsConfig(json) {
+    const appSettingsConfig = {};
+    if (json.settings?.global) {
+        appSettingsConfig.global = {};
+        for (const [name, setting] of Object.entries(json.settings.global)) {
+            appSettingsConfig.global[name] = {
+                ...setting,
+                name: name,
+            };
+        }
+    }
+    if (json.settings?.subreddit) {
+        appSettingsConfig.subreddit = {};
+        for (const [name, setting] of Object.entries(json.settings.subreddit)) {
+            appSettingsConfig.subreddit[name] = {
+                ...setting,
+                name: name,
+            };
+        }
+    }
+    return appSettingsConfig;
+}
+/** @internal */
+export function validate(config) {
+    const errs = [];
+    if (config.menu?.items?.length && !config.permissions.redis)
+        errs.push('`config.menu.items` requires `config.permissions.redis` to be enabled');
+    // If there are any select settings, their default values must be in the options,
+    // and if it's not a multi-select, the default value must be a single string.
+    const settingValues = [
+        ...Object.values(config.settings?.global ?? {}),
+        ...Object.values(config.settings?.subreddit ?? {}),
+    ];
+    for (const setting of settingValues) {
+        if (setting.type === 'select' && setting.defaultValue) {
+            if (!setting.options.some((option) => option.value === setting.defaultValue))
+                errs.push(`Setting "${setting.name}" default value "${setting.defaultValue}" is not in
+          options "${setting.options.map((option) => option.value).join(', ')}"`);
+        }
+        if (setting.type === 'multiSelect' && setting.defaultValue) {
+            if (!setting.defaultValue.every((value) => setting.options.some((option) => option.value === value)))
+                errs.push(`Setting "${setting.name}" default values "${setting.defaultValue.join(', ')}" are not in options "${setting.options.map((option) => option.value).join(', ')}"`);
+        }
+    }
+    if (errs.length)
+        throw Error(`${errs.join('; ')}.`);
+}