@devvit/shared-types 0.10.24 → 0.10.25-next-2024-08-19-f27845e8c.0

package/Assets.d.ts

@@ -13,6 +13,7 @@ export type AssetMap = {
     [path: string]: string;
 };
 export declare const ASSET_DIRNAME = "assets";
+export declare const WEBVIEW_ASSET_DIRNAME = "webroot";
 export declare const ALLOWED_ASSET_EXTENSIONS: string[];
 export declare const KILOBYTE = 1024;
 export declare const MEGABYTE: number;

package/Assets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Assets.d.ts","sourceRoot":"","sources":["../src/Assets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAElD,eAAO,MAAM,aAAa,WAAW,CAAC;AAKtC,eAAO,MAAM,wBAAwB,UAA6C,CAAC;AAEnF,eAAO,MAAM,QAAQ,OAAO,CAAC;AAC7B,eAAO,MAAM,QAAQ,QAAsB,CAAC;AAC5C,eAAO,MAAM,QAAQ,QAAsB,CAAC;AAC5C,eAAO,MAAM,2BAA2B,QAAW,CAAC;AACpD,eAAO,MAAM,kBAAkB,QAAgB,CAAC;AAChD,eAAO,MAAM,sBAAsB,QAAgB,CAAC;AAEpD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYrD"}
+{"version":3,"file":"Assets.d.ts","sourceRoot":"","sources":["../src/Assets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAElD,eAAO,MAAM,aAAa,WAAW,CAAC;AACtC,eAAO,MAAM,qBAAqB,YAAY,CAAC;AAK/C,eAAO,MAAM,wBAAwB,UAA6C,CAAC;AAEnF,eAAO,MAAM,QAAQ,OAAO,CAAC;AAC7B,eAAO,MAAM,QAAQ,QAAsB,CAAC;AAC5C,eAAO,MAAM,QAAQ,QAAsB,CAAC;AAC5C,eAAO,MAAM,2BAA2B,QAAW,CAAC;AACpD,eAAO,MAAM,kBAAkB,QAAgB,CAAC;AAChD,eAAO,MAAM,sBAAsB,QAAgB,CAAC;AAEpD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYrD"}

package/Assets.js

@@ -1,4 +1,5 @@
 export const ASSET_DIRNAME = 'assets';
+export const WEBVIEW_ASSET_DIRNAME = 'webroot';
 // List of allowed asset extensions. Note that this should not be used as definitive proof that
 // an asset is valid, as it is possible to spoof the extension of a file. This is just a quick
 // check to make sure the file is probably an image.

package/Config.d.ts

@@ -13,6 +13,7 @@ import type { Namespace } from './Namespace.js';
 export type Config = {
     readonly assets: Readonly<AssetMap>;
     readonly providedDefinitions: Readonly<Definition>[];
+    readonly webviewAssets?: Readonly<AssetMap> | undefined;
     export(namespace: Readonly<Namespace>): DependencySpec;
     provides(definition: Readonly<Definition>): void;
     use<T>(definition: Readonly<Definition>, options?: Readonly<DeepPartial<PackageQuery>>): T;

package/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEpC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;IAErD,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;IAEvD,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAEjD,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC;IAE3F;;;;OAIG;IACH,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;CACjD,CAAC"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEpC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;IAErD,QAAQ,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;IAExD,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;IAEvD,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAEjD,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC;IAE3F;;;;OAIG;IACH,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;CACjD,CAAC"}

package/ConfigImpl.d.ts

@@ -0,0 +1,20 @@
+import { ActorSpec, Definition, DependencySpec, PackageQuery } from '@devvit/protos';
+import type { AssetMap } from './Assets.js';
+import type { DeepPartial } from './BuiltinTypes.js';
+import type { Config } from './Config.js';
+import type { Namespace } from './Namespace.js';
+export type ClientFactory = {
+    Build<T>(desc: Definition, spec: PackageQuery): T;
+};
+export declare class ConfigImpl implements Config {
+    #private;
+    get assets(): Readonly<AssetMap>;
+    get webviewAssets(): Readonly<AssetMap>;
+    get providedDefinitions(): Readonly<Definition>[];
+    constructor(factory: ClientFactory, actorSpec: ActorSpec, assets: AssetMap, webviewAssets: AssetMap);
+    export(namespace: Readonly<Namespace>): DependencySpec;
+    provides(definition: Readonly<Definition>): void;
+    use<T>(definition: Readonly<Definition>, options?: Readonly<DeepPartial<PackageQuery>>): T;
+    uses(definition: Readonly<Definition>): boolean;
+}
+//# sourceMappingURL=ConfigImpl.d.ts.map

package/ConfigImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigImpl.d.ts","sourceRoot":"","sources":["../src/ConfigImpl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAe,MAAM,gBAAgB,CAAC;AAClG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAIhD,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,GAAG,CAAC,CAAC;CACnD,CAAC;AAEF,qBAAa,UAAW,YAAW,MAAM;;IASvC,IAAI,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAE/B;IAED,IAAI,aAAa,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAEtC;IAED,IAAI,mBAAmB,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAEhD;gBAGC,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,QAAQ,EAChB,aAAa,EAAE,QAAQ;IAUzB,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,cAAc;IActD,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI;IAIhD,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAE,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAM,GAAG,CAAC;IAY9F,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,OAAO;CAWhD"}

package/ConfigImpl.js

@@ -0,0 +1,80 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _ConfigImpl_instances, _ConfigImpl_factory, _ConfigImpl_name, _ConfigImpl_owner, _ConfigImpl_provides, _ConfigImpl_useQueries, _ConfigImpl_version, _ConfigImpl_assets, _ConfigImpl_webviewAssets, _ConfigImpl_newActorSpec;
+import { ActorSpec, Definition, DependencySpec, PackageQuery, PackageSpec } from '@devvit/protos';
+import { NonNull } from './NonNull.js';
+import { PLUGIN_NAME, resolveActorHostname } from './HostnameUtil.js';
+export class ConfigImpl {
+    get assets() {
+        return __classPrivateFieldGet(this, _ConfigImpl_assets, "f");
+    }
+    get webviewAssets() {
+        return __classPrivateFieldGet(this, _ConfigImpl_webviewAssets, "f");
+    }
+    get providedDefinitions() {
+        return __classPrivateFieldGet(this, _ConfigImpl_provides, "f");
+    }
+    constructor(factory, actorSpec, assets, webviewAssets) {
+        _ConfigImpl_instances.add(this);
+        _ConfigImpl_factory.set(this, void 0);
+        _ConfigImpl_name.set(this, void 0);
+        _ConfigImpl_owner.set(this, void 0);
+        _ConfigImpl_provides.set(this, []);
+        _ConfigImpl_useQueries.set(this, []);
+        _ConfigImpl_version.set(this, void 0);
+        _ConfigImpl_assets.set(this, void 0);
+        _ConfigImpl_webviewAssets.set(this, void 0);
+        __classPrivateFieldSet(this, _ConfigImpl_factory, factory, "f");
+        __classPrivateFieldSet(this, _ConfigImpl_name, actorSpec.name, "f");
+        __classPrivateFieldSet(this, _ConfigImpl_owner, actorSpec.owner, "f");
+        __classPrivateFieldSet(this, _ConfigImpl_version, actorSpec.version, "f");
+        __classPrivateFieldSet(this, _ConfigImpl_assets, Object.freeze(assets), "f");
+        __classPrivateFieldSet(this, _ConfigImpl_webviewAssets, Object.freeze(webviewAssets), "f");
+    }
+    export(namespace) {
+        return DependencySpec.fromPartial({
+            actor: __classPrivateFieldGet(this, _ConfigImpl_instances, "m", _ConfigImpl_newActorSpec).call(this),
+            hostname: resolveActorHostname(NonNull(__classPrivateFieldGet(this, _ConfigImpl_name, "f")), namespace),
+            provides: __classPrivateFieldGet(this, _ConfigImpl_provides, "f").map((definition) => {
+                return PackageSpec.fromPartial({
+                    actor: __classPrivateFieldGet(this, _ConfigImpl_instances, "m", _ConfigImpl_newActorSpec).call(this),
+                    definition: Definition.toSerializable(definition),
+                });
+            }),
+            uses: __classPrivateFieldGet(this, _ConfigImpl_useQueries, "f"),
+        });
+    }
+    provides(definition) {
+        __classPrivateFieldGet(this, _ConfigImpl_provides, "f").push(definition);
+    }
+    use(definition, options = {}) {
+        const query = PackageQuery.fromPartial({
+            ...options,
+            name: options.name ?? PLUGIN_NAME,
+            owner: options.owner,
+            versions: options.versions,
+            typeName: definition.fullName,
+        });
+        __classPrivateFieldGet(this, _ConfigImpl_useQueries, "f").push(query);
+        return __classPrivateFieldGet(this, _ConfigImpl_factory, "f").Build(definition, query);
+    }
+    uses(definition) {
+        return __classPrivateFieldGet(this, _ConfigImpl_useQueries, "f").some((query) => query.typeName === definition.fullName);
+    }
+}
+_ConfigImpl_factory = new WeakMap(), _ConfigImpl_name = new WeakMap(), _ConfigImpl_owner = new WeakMap(), _ConfigImpl_provides = new WeakMap(), _ConfigImpl_useQueries = new WeakMap(), _ConfigImpl_version = new WeakMap(), _ConfigImpl_assets = new WeakMap(), _ConfigImpl_webviewAssets = new WeakMap(), _ConfigImpl_instances = new WeakSet(), _ConfigImpl_newActorSpec = function _ConfigImpl_newActorSpec() {
+    return ActorSpec.fromPartial({
+        name: __classPrivateFieldGet(this, _ConfigImpl_name, "f") ?? '',
+        owner: __classPrivateFieldGet(this, _ConfigImpl_owner, "f") ?? '',
+        version: __classPrivateFieldGet(this, _ConfigImpl_version, "f") ?? '',
+    });
+};

package/HostnameUtil.d.ts

@@ -0,0 +1,83 @@
+import type { Definition, SerializableServiceDefinition } from '@devvit/protos';
+import type { Namespace } from './Namespace.js';
+/** Actor in the platform, not in a user Bundle. */
+export declare const PLUGIN_NAME: string;
+/** Actor in the platform, not in a user Bundle. */
+export declare const PLUGIN_OWNER: string;
+export declare const LOCAL_HOSTNAME: string;
+export declare const NODE_HOSTNAME = "node";
+export declare const ECHO_CNAME = "echo";
+export declare const INSPECTOR_CNAME = "inspector";
+export declare const RUNTIME_CNAME = "runtime";
+export declare const SUPERVISOR_CNAME = "supervisor";
+export declare const SCHEDULER_CNAME = "scheduler";
+export declare const REDDIT_API_CNAME = "redditapi";
+export declare function resolveActorHostname(name: string, namespace: Readonly<Namespace>): string;
+export declare function resolvePluginHostname(name: string, namespace: Readonly<Namespace>): string;
+export declare function resolveSystemHostname(name: string, namespace: Readonly<Namespace>): string;
+export declare function resolveActorDefinitionHostname(definition: Readonly<Definition | SerializableServiceDefinition>, namespace: Readonly<Namespace>): string;
+export declare function resolvePluginDefinitionHostname(definition: Readonly<Definition | SerializableServiceDefinition>, namespace: Readonly<Namespace>): string;
+export declare function resolveSystemDefinitionHostname(definition: Readonly<Definition | SerializableServiceDefinition>, namespace: Readonly<Namespace>): string;
+/**
+ * Forms a hostname under namespace. Eg:
+ *
+ *   123, abc.local → 123.abc.local
+ *   123, local → 123.local
+ */
+export declare function childHostname(name: string, namespace: Readonly<Namespace>): string;
+/**
+ * Forms a hostname with the same parent as namespace. Eg:
+ *
+ *   123, abc.def.local → 123.def.local
+ *   123, def.local → 123.local
+ *   123, local → 123
+ */
+export declare function siblingHostname(name: string, namespace: Readonly<Namespace>): string;
+/**
+ * Returns the next level up of hostname. Eg:
+ *
+ *   123.abc.local → abc.local
+ *   abc.local → local
+ *   local → ''
+ */
+export declare function parentHostname(hostname: string): string;
+export declare function parentHostname(namespace: Namespace): string;
+/**
+ * Returns true if left-hand-side is or descends from right-hand-side. Ex:
+ *
+ * | LHS     | RHS   | Output |
+ * | ------- | ----- | ------ |
+ * | local   | local | true   |
+ * | a.local | local | true   |
+ * | a.node  | local | false  |
+ */
+export declare function isDescendantHostname(lhs: string, rhs: string): boolean;
+export declare namespace Hostname {
+    /**
+     * Returns the leaf subdomain of hostname. Ex:
+     *
+     * | Hostname | Output |
+     * | -------- | ------ |
+     * | local    | local  |
+     * | a.local  | a      |
+     * | a.node   | a      |
+     * | a.b.node | a      |
+     */
+    function getChild(hostname: string): string;
+    /**
+     * Returns the leaf subdomain of hostname. Ex:
+     *
+     * | Hostname | Output |
+     * | -------- | ------ |
+     * | local    | local  |
+     * | a.local  | local  |
+     * | a.node   | node   |
+     * | a.b.node | local  |
+     */
+    function getRoot(hostname: string): string;
+    function getPluginNamespace(namespace: Readonly<Namespace>): Namespace;
+    function getSystemNamespace(namespace: Readonly<Namespace>): Namespace;
+    function isPlugin(hostname: string, namespace: Readonly<Namespace>): boolean;
+    function isSystem(hostname: string, namespace: Readonly<Namespace>): boolean;
+}
+//# sourceMappingURL=HostnameUtil.d.ts.map

package/HostnameUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HostnameUtil.d.ts","sourceRoot":"","sources":["../src/HostnameUtil.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAChF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,mDAAmD;AACnD,eAAO,MAAM,WAAW,EAAE,MAAkB,CAAC;AAE7C,mDAAmD;AACnD,eAAO,MAAM,YAAY,EAAE,MAAiB,CAAC;AAE7C,eAAO,MAAM,cAAc,EAAE,MAAgB,CAAC;AAC9C,eAAO,MAAM,aAAa,SAAS,CAAC;AAEpC,eAAO,MAAM,UAAU,SAAS,CAAC;AACjC,eAAO,MAAM,eAAe,cAAc,CAAC;AAC3C,eAAO,MAAM,aAAa,YAAY,CAAC;AACvC,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAC7C,eAAO,MAAM,eAAe,cAAc,CAAC;AAC3C,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,MAAM,CAEzF;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,MAAM,CAE1F;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,MAAM,CAE1F;AAED,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,QAAQ,CAAC,UAAU,GAAG,6BAA6B,CAAC,EAChE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAC7B,MAAM,CAER;AAED,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,QAAQ,CAAC,UAAU,GAAG,6BAA6B,CAAC,EAChE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAC7B,MAAM,CAER;AAED,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,QAAQ,CAAC,UAAU,GAAG,6BAA6B,CAAC,EAChE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAC7B,MAAM,CAER;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,MAAM,CAGlF;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,MAAM,CAIpF;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;AACzD,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAAC;AAQ7D;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAGtE;AAOD,yBAAiB,QAAQ,CAAC;IACxB;;;;;;;;;OASG;IACH,SAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEjD;IAED;;;;;;;;;OASG;IACH,SAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEhD;IAED,SAAgB,kBAAkB,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAE5E;IAED,SAAgB,kBAAkB,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAE5E;IAED,SAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO,CAElF;IAED,SAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO,CAElF;CACF"}

package/HostnameUtil.js

@@ -0,0 +1,127 @@
+import { NonNull } from './NonNull.js';
+/** Actor in the platform, not in a user Bundle. */
+export const PLUGIN_NAME = 'default';
+/** Actor in the platform, not in a user Bundle. */
+export const PLUGIN_OWNER = 'devvit';
+export const LOCAL_HOSTNAME = 'local';
+export const NODE_HOSTNAME = 'node';
+export const ECHO_CNAME = 'echo';
+export const INSPECTOR_CNAME = 'inspector';
+export const RUNTIME_CNAME = 'runtime';
+export const SUPERVISOR_CNAME = 'supervisor';
+export const SCHEDULER_CNAME = 'scheduler';
+export const REDDIT_API_CNAME = 'redditapi';
+export function resolveActorHostname(name, namespace) {
+    return childHostname(name, namespace);
+}
+export function resolvePluginHostname(name, namespace) {
+    return childHostname(name, Hostname.getPluginNamespace(namespace));
+}
+export function resolveSystemHostname(name, namespace) {
+    return childHostname(name, Hostname.getSystemNamespace(namespace));
+}
+export function resolveActorDefinitionHostname(definition, namespace) {
+    return resolveActorHostname(definition.name, namespace);
+}
+export function resolvePluginDefinitionHostname(definition, namespace) {
+    return resolvePluginHostname(definition.name, namespace);
+}
+export function resolveSystemDefinitionHostname(definition, namespace) {
+    return resolveSystemHostname(definition.name, namespace);
+}
+/**
+ * Forms a hostname under namespace. Eg:
+ *
+ *   123, abc.local → 123.abc.local
+ *   123, local → 123.local
+ */
+export function childHostname(name, namespace) {
+    if (namespace.hostname == null)
+        throw Error('Unbound namespace.');
+    return `${name}.${namespace.hostname}`.toLocaleLowerCase();
+}
+/**
+ * Forms a hostname with the same parent as namespace. Eg:
+ *
+ *   123, abc.def.local → 123.def.local
+ *   123, def.local → 123.local
+ *   123, local → 123
+ */
+export function siblingHostname(name, namespace) {
+    if (namespace.hostname == null)
+        throw Error('Unbound namespace.');
+    if (parentHostname(namespace) === name)
+        return name.toLocaleLowerCase();
+    return `${name.toLocaleLowerCase()}.${parentHostname(namespace)}`;
+}
+export function parentHostname(hostnameOrNamespace) {
+    const hostname = typeof hostnameOrNamespace === 'string' ? hostnameOrNamespace : hostnameOrNamespace.hostname;
+    if (hostname == null)
+        throw Error('Unbound namespace.');
+    return hostname.split('.').slice(1).join('.').toLocaleLowerCase();
+}
+/**
+ * Returns true if left-hand-side is or descends from right-hand-side. Ex:
+ *
+ * | LHS     | RHS   | Output |
+ * | ------- | ----- | ------ |
+ * | local   | local | true   |
+ * | a.local | local | true   |
+ * | a.node  | local | false  |
+ */
+export function isDescendantHostname(lhs, rhs) {
+    const suffix = `.${rhs}`;
+    return lhs === rhs || (lhs.length > suffix.length && lhs.endsWith(suffix));
+}
+// to-do: Move other methods under namespace,
+// `import {Hostname} from 'Hostname.js'` wherever used, and use like:
+// - `Hostname.getParent('about.reddit.com')`,
+// - `Hostname.getChild('about.reddit.com')`,
+// - `Hostname.addChild('about', 'reddit.com')`
+export var Hostname;
+(function (Hostname) {
+    /**
+     * Returns the leaf subdomain of hostname. Ex:
+     *
+     * | Hostname | Output |
+     * | -------- | ------ |
+     * | local    | local  |
+     * | a.local  | a      |
+     * | a.node   | a      |
+     * | a.b.node | a      |
+     */
+    function getChild(hostname) {
+        return hostname.split('.')[0];
+    }
+    Hostname.getChild = getChild;
+    /**
+     * Returns the leaf subdomain of hostname. Ex:
+     *
+     * | Hostname | Output |
+     * | -------- | ------ |
+     * | local    | local  |
+     * | a.local  | local  |
+     * | a.node   | node   |
+     * | a.b.node | local  |
+     */
+    function getRoot(hostname) {
+        return NonNull(hostname.split('.').at(-1));
+    }
+    Hostname.getRoot = getRoot;
+    function getPluginNamespace(namespace) {
+        return { hostname: childHostname('plugins', namespace) };
+    }
+    Hostname.getPluginNamespace = getPluginNamespace;
+    function getSystemNamespace(namespace) {
+        return { hostname: childHostname('system', namespace) };
+    }
+    Hostname.getSystemNamespace = getSystemNamespace;
+    function isPlugin(hostname, namespace) {
+        return isDescendantHostname(hostname, NonNull(getPluginNamespace(namespace).hostname));
+    }
+    Hostname.isPlugin = isPlugin;
+    function isSystem(hostname, namespace) {
+        return isDescendantHostname(hostname, NonNull(getSystemNamespace(namespace).hostname));
+    }
+    Hostname.isSystem = isSystem;
+})(Hostname || (Hostname = {}));

package/HostnameUtil.test.d.ts.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.10.24",
+  "version": "0.10.25-next-2024-08-19-f27845e8c.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -23,12 +23,12 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.10.24"
+    "@devvit/protos": "0.10.25-next-2024-08-19-f27845e8c.0"
   },
   "devDependencies": {
-    "@devvit/eslint-config": "0.10.24",
-    "@devvit/repo-tools": "0.10.24",
-    "@devvit/tsconfig": "0.10.24",
+    "@devvit/eslint-config": "0.10.25-next-2024-08-19-f27845e8c.0",
+    "@devvit/repo-tools": "0.10.25-next-2024-08-19-f27845e8c.0",
+    "@devvit/tsconfig": "0.10.25-next-2024-08-19-f27845e8c.0",
     "@types/redis-mock": "0.17.1",
     "eslint": "8.9.0",
     "lit": "2.2.8",
@@ -41,5 +41,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "ed7050e0bcc11f082f6eb61f3ec09c6b00b3353a"
+  "gitHead": "dbd87ac789657b76c0550b429ce7038d1506e595"
 }