@devvit/shared-types 0.11.0-next-2024-08-12-966265c0a.0 → 0.11.0-next-2024-08-12-80e9fc2a4.0

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.11.0-next-2024-08-12-966265c0a.0",
+  "version": "0.11.0-next-2024-08-12-80e9fc2a4.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -24,14 +24,14 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.0-next-2024-08-12-966265c0a.0",
+    "@devvit/protos": "0.11.0-next-2024-08-12-80e9fc2a4.0",
     "jsonschema": "1.4.1",
     "uuid": "9.0.0"
   },
   "devDependencies": {
-    "@devvit/eslint-config": "0.11.0-next-2024-08-12-966265c0a.0",
-    "@devvit/repo-tools": "0.11.0-next-2024-08-12-966265c0a.0",
-    "@devvit/tsconfig": "0.11.0-next-2024-08-12-966265c0a.0",
+    "@devvit/eslint-config": "0.11.0-next-2024-08-12-80e9fc2a4.0",
+    "@devvit/repo-tools": "0.11.0-next-2024-08-12-80e9fc2a4.0",
+    "@devvit/tsconfig": "0.11.0-next-2024-08-12-80e9fc2a4.0",
     "@types/redis-mock": "0.17.1",
     "@types/uuid": "9.0.0",
     "eslint": "8.9.0",
@@ -45,5 +45,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "a6e2b727919ed858a2fc2a79fd7b65ace6ee3b95"
+  "gitHead": "23da84d172e0345dbc474de2199d9102a5890ee9"
 }