@devvit/settings 0.12.6-next-2025-12-10-15-48-50-47f19f303.0 → 0.12.6-next-2025-12-10-22-48-08-763e72963.0

package/SettingsClient.d.ts

@@ -12,4 +12,6 @@ export declare function getSettingsValues(results: {
     readonly [key: string]: FormFieldValue;
 }, settingsDefinitions: FormField[] | undefined): SettingsValues;
 export declare function setDefaultsIfNecessary(settingsValues: SettingsValues, settingsDefinitions: FormField[]): void;
+export declare function flattenFormFieldValue(value: FormFieldValue): undefined | string | string[] | number | boolean;
+export declare function toFormFieldValue(value: unknown): FormFieldValue;
 //# sourceMappingURL=SettingsClient.d.ts.map

package/SettingsClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsClient.d.ts","sourceRoot":"","sources":["../src/SettingsClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAIpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iEAAiE,CAAC;AAExG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,qBAAa,cAAc;;IACnB,GAAG,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,SAAS,EAC5D,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAKnB,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC;CA0B9D;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAsCjE;AAED,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,EACnD,mBAAmB,EAAE,SAAS,EAAE,GAAG,SAAS,GAC3C,cAAc,CAWhB;AAED,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,SAAS,EAAE,GAC/B,IAAI,CAeN"}
+{"version":3,"file":"SettingsClient.d.ts","sourceRoot":"","sources":["../src/SettingsClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAIpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iEAAiE,CAAC;AAExG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,qBAAa,cAAc;;IACnB,GAAG,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,SAAS,EAC5D,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAKnB,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC;CA0B9D;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAsCjE;AAED,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,EACnD,mBAAmB,EAAE,SAAS,EAAE,GAAG,SAAS,GAC3C,cAAc,CAWhB;AAED,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,SAAS,EAAE,GAC/B,IAAI,CAeN;AAED,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,cAAc,GACpB,SAAS,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,OAAO,CAkBlD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAgB/D"}

package/SettingsClient.js

@@ -94,7 +94,7 @@ export function setDefaultsIfNecessary(settingsValues, settingsDefinitions) {
         }
     }
 }
-function flattenFormFieldValue(value) {
+export function flattenFormFieldValue(value) {
     switch (value.fieldType) {
         case FormFieldType.STRING:
             return value.stringValue;
@@ -113,3 +113,21 @@ function flattenFormFieldValue(value) {
             return undefined;
     }
 }
+export function toFormFieldValue(value) {
+    if (typeof value === 'string') {
+        return { fieldType: FormFieldType.STRING, stringValue: value };
+    }
+    else if (typeof value === 'boolean') {
+        return { fieldType: FormFieldType.BOOLEAN, boolValue: value };
+    }
+    else if (typeof value === 'number') {
+        return { fieldType: FormFieldType.NUMBER, numberValue: value };
+    }
+    else if (Array.isArray(value)) {
+        return {
+            fieldType: FormFieldType.SELECTION,
+            selectionValue: { values: value.map(String) },
+        };
+    }
+    throw new Error(`Unsupported value type: ${typeof value}. Expected string, boolean, number, or array.`);
+}

package/mocks/SettingsMock.d.ts

@@ -0,0 +1,56 @@
+import { type Metadata, type Settings } from '@devvit/protos';
+import type { SettingsRequest, SettingsResponse, SettingsValues } from '@devvit/protos/types/devvit/plugin/settings/v1alpha/settings.js';
+import type { PluginMock } from '@devvit/shared-types/test/index.js';
+export declare class SettingsPluginMock implements Settings {
+    private readonly _state;
+    constructor(state: {
+        current: SettingsValues;
+    });
+    GetSettings(_request: SettingsRequest, _metadata?: Metadata): Promise<SettingsResponse>;
+}
+export declare class SettingsMock implements PluginMock<Settings> {
+    readonly plugin: SettingsPluginMock;
+    private readonly _state;
+    constructor(initialSettings?: {
+        [key: string]: unknown;
+    });
+    /**
+     * Overwrites the mocked settings with new values.
+     * Replaces existing settings completely.
+     *
+     * @param settings - The new settings to replace the current ones.
+     */
+    set(settings: {
+        [key: string]: unknown;
+    }): void;
+    /**
+     * Updates the mocked settings with new values.
+     * Merges with existing settings.
+     *
+     * @param settings - The new settings to merge in.
+     */
+    update(settings: {
+        [key: string]: unknown;
+    }): void;
+    /**
+     * Adds or updates a single setting value.
+     *
+     * @param key - The setting key.
+     * @param value - The value to set.
+     */
+    put(key: string, value: unknown): void;
+    /**
+     * Removes a setting by key.
+     *
+     * @param key - The setting key to remove.
+     */
+    remove(key: string): void;
+    /**
+     * Gets the current settings values.
+     *
+     * @returns The current SettingsValues object.
+     */
+    get(): SettingsValues;
+    private _createSettingsValues;
+}
+//# sourceMappingURL=SettingsMock.d.ts.map

package/mocks/SettingsMock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsMock.d.ts","sourceRoot":"","sources":["../../src/mocks/SettingsMock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,cAAc,EACf,MAAM,iEAAiE,CAAC;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAIrE,qBAAa,kBAAmB,YAAW,QAAQ;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA8B;gBACzC,KAAK,EAAE;QAAE,OAAO,EAAE,cAAc,CAAA;KAAE;IAIxC,WAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAO9F;AAED,qBAAa,YAAa,YAAW,UAAU,CAAC,QAAQ,CAAC;IACvD,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA8B;gBAEzC,eAAe,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAO;IAK5D;;;;;OAKG;IACH,GAAG,CAAC,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI;IAK/C;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI;IAQlD;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAItC;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIzB;;;;OAIG;IACH,GAAG,IAAI,cAAc;IAIrB,OAAO,CAAC,qBAAqB;CAU9B"}

package/mocks/SettingsMock.js

@@ -0,0 +1,78 @@
+import {} from '@devvit/protos';
+import { toFormFieldValue } from '../SettingsClient.js';
+export class SettingsPluginMock {
+    constructor(state) {
+        this._state = state;
+    }
+    async GetSettings(_request, _metadata) {
+        return {
+            appSettings: this._state.current,
+            installationSettings: { version: '0', settings: {} },
+            instanceSettings: { version: '0', settings: {} },
+        };
+    }
+}
+export class SettingsMock {
+    constructor(initialSettings = {}) {
+        this._state = { current: this._createSettingsValues(initialSettings) };
+        this.plugin = new SettingsPluginMock(this._state);
+    }
+    /**
+     * Overwrites the mocked settings with new values.
+     * Replaces existing settings completely.
+     *
+     * @param settings - The new settings to replace the current ones.
+     */
+    set(settings) {
+        const newValues = this._createSettingsValues(settings);
+        this._state.current = newValues;
+    }
+    /**
+     * Updates the mocked settings with new values.
+     * Merges with existing settings.
+     *
+     * @param settings - The new settings to merge in.
+     */
+    update(settings) {
+        const newValues = this._createSettingsValues(settings);
+        this._state.current = {
+            ...this._state.current,
+            settings: { ...this._state.current.settings, ...newValues.settings },
+        };
+    }
+    /**
+     * Adds or updates a single setting value.
+     *
+     * @param key - The setting key.
+     * @param value - The value to set.
+     */
+    put(key, value) {
+        this.update({ [key]: value });
+    }
+    /**
+     * Removes a setting by key.
+     *
+     * @param key - The setting key to remove.
+     */
+    remove(key) {
+        delete this._state.current.settings[key];
+    }
+    /**
+     * Gets the current settings values.
+     *
+     * @returns The current SettingsValues object.
+     */
+    get() {
+        return this._state.current;
+    }
+    _createSettingsValues(settings) {
+        const formFields = {};
+        for (const [key, value] of Object.entries(settings)) {
+            formFields[key] = toFormFieldValue(value);
+        }
+        return {
+            version: '1',
+            settings: formFields,
+        };
+    }
+}

package/mocks/SettingsMock.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsMock.test.d.ts","sourceRoot":"","sources":["../../src/mocks/SettingsMock.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/settings",
-  "version": "0.12.6-next-2025-12-10-15-48-50-47f19f303.0",
+  "version": "0.12.6-next-2025-12-10-22-48-08-763e72963.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -12,7 +12,8 @@
       "browser": "./serverImportInClientCodePanic.js",
       "default": "./index.js"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./test": "./test.js"
   },
   "files": [
     "**"
@@ -31,20 +32,20 @@
     "test:unit-with-coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@devvit/protos": "0.12.6-next-2025-12-10-15-48-50-47f19f303.0",
-    "@devvit/shared": "0.12.6-next-2025-12-10-15-48-50-47f19f303.0",
-    "@devvit/shared-types": "0.12.6-next-2025-12-10-15-48-50-47f19f303.0"
+    "@devvit/protos": "0.12.6-next-2025-12-10-22-48-08-763e72963.0",
+    "@devvit/shared": "0.12.6-next-2025-12-10-22-48-08-763e72963.0",
+    "@devvit/shared-types": "0.12.6-next-2025-12-10-22-48-08-763e72963.0"
   },
   "peerDependencies": {
     "@devvit/server": "*"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.12.6-next-2025-12-10-15-48-50-47f19f303.0",
-    "@devvit/server": "0.12.6-next-2025-12-10-15-48-50-47f19f303.0",
-    "@devvit/tsconfig": "0.12.6-next-2025-12-10-15-48-50-47f19f303.0",
+    "@devvit/repo-tools": "0.12.6-next-2025-12-10-22-48-08-763e72963.0",
+    "@devvit/server": "0.12.6-next-2025-12-10-22-48-08-763e72963.0",
+    "@devvit/tsconfig": "0.12.6-next-2025-12-10-22-48-08-763e72963.0",
     "eslint": "9.11.1",
     "typescript": "5.8.3",
     "vitest": "1.6.1"
   },
-  "gitHead": "19c1429865d75355371655e3479f113df0dfef6b"
+  "gitHead": "44e0988227c8b742f3ba2a22b65f8d69baec1e18"
 }

package/test.d.ts

@@ -0,0 +1,2 @@
+export * from './mocks/SettingsMock.js';
+//# sourceMappingURL=test.d.ts.map

package/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/test.js

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