@devvit/shared-types 0.12.2-next-2025-10-16-22-26-47-63705be33.0 → 0.12.2-next-2025-10-16-22-45-34-2b8054235.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.12.2-next-2025-10-16-22-26-47-63705be33.0",
+  "version": "0.12.2-next-2025-10-16-22-45-34-2b8054235.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -33,13 +33,13 @@
   },
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.12.2-next-2025-10-16-22-26-47-63705be33.0",
+    "@devvit/protos": "0.12.2-next-2025-10-16-22-45-34-2b8054235.0",
     "jsonschema": "1.4.1",
     "uuid": "9.0.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.12.2-next-2025-10-16-22-26-47-63705be33.0",
-    "@devvit/tsconfig": "0.12.2-next-2025-10-16-22-26-47-63705be33.0",
+    "@devvit/repo-tools": "0.12.2-next-2025-10-16-22-45-34-2b8054235.0",
+    "@devvit/tsconfig": "0.12.2-next-2025-10-16-22-45-34-2b8054235.0",
     "@types/redis-mock": "0.17.1",
     "@types/uuid": "9.0.0",
     "chokidar-cli": "3.0.0",
@@ -51,5 +51,5 @@
     "vitest": "1.6.1"
   },
   "source": "./src/index.ts",
-  "gitHead": "aa4adc4f1f4e39a872806f9436760143b8060908"
+  "gitHead": "731d5ab06d6d38a7830d585977d0bdcb6ed28415"
 }

package/slug.d.ts

@@ -2,6 +2,18 @@ export declare const APP_ACCOUNT_NAME_LENGTH_LIMIT = 20;
 export declare const UNIQUE_SLUG_SUFFIX_LENGTH = 3;
 export declare const APP_SLUG_BASE_MIN_LENGTH = 3;
 export declare const APP_SLUG_BASE_MAX_LENGTH: number;
-export declare function sluggable(str: string): boolean;
+/**
+ * Returns a string describing why the input is not sluggable, or undefined if it is sluggable.
+ *
+ * @example
+ * ```tsx
+ * const err = validateSluggable('My App 1');
+ * if (err) {
+ *   throw new Error(`App name is not valid. (${err})`);
+ * }
+ * const slug = makeSlug('My App 1'); // 'my-app-1'
+ * ```
+ */
+export declare function validateSluggable(str: string): string | undefined;
 export declare function makeSlug(str: string): string;
 //# sourceMappingURL=slug.d.ts.map

package/slug.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"slug.d.ts","sourceRoot":"","sources":["../src/slug.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,yBAAyB,IAAI,CAAC;AAG3C,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAC1C,eAAO,MAAM,wBAAwB,QAC0B,CAAC;AAIhE,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAQ9C;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAc5C"}
+{"version":3,"file":"slug.d.ts","sourceRoot":"","sources":["../src/slug.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,yBAAyB,IAAI,CAAC;AAG3C,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAC1C,eAAO,MAAM,wBAAwB,QAC0B,CAAC;AAIhE;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAcjE;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM5C"}

package/slug.js

@@ -4,27 +4,37 @@ export const UNIQUE_SLUG_SUFFIX_LENGTH = 3;
 export const APP_SLUG_BASE_MIN_LENGTH = 3;
 export const APP_SLUG_BASE_MAX_LENGTH = APP_ACCOUNT_NAME_LENGTH_LIMIT - UNIQUE_SLUG_SUFFIX_LENGTH - 1;
 const ALLOWED_SLUG_REGEX = /^[a-z][a-z0-9-]*$/;
-export function sluggable(str) {
+/**
+ * Returns a string describing why the input is not sluggable, or undefined if it is sluggable.
+ *
+ * @example
+ * ```tsx
+ * const err = validateSluggable('My App 1');
+ * if (err) {
+ *   throw new Error(`App name is not valid. (${err})`);
+ * }
+ * const slug = makeSlug('My App 1'); // 'my-app-1'
+ * ```
+ */
+export function validateSluggable(str) {
     const slug = str.replace(/\s+/g, '-').toLowerCase();
-    if (slug.length < APP_SLUG_BASE_MIN_LENGTH || slug.length > APP_SLUG_BASE_MAX_LENGTH) {
-        return false;
+    if (slug.length < APP_SLUG_BASE_MIN_LENGTH) {
+        return `name length must be longer than ${APP_SLUG_BASE_MIN_LENGTH} characters; length: ${slug.length}`;
+    }
+    if (slug.length > APP_SLUG_BASE_MAX_LENGTH) {
+        return `name length must be shorter than ${APP_SLUG_BASE_MAX_LENGTH} characters; length: ${slug.length}`;
+    }
+    if (!ALLOWED_SLUG_REGEX.test(slug)) {
+        return `invalid characters; only use a-z, 0-9, and -`;
+    }
+    if (slug.includes('reddit')) {
+        return `name cannot contain the word "reddit"`;
     }
-    return ALLOWED_SLUG_REGEX.test(slug);
 }
 export function makeSlug(str) {
-    if (!sluggable(str)) {
-        const slug = str.replace(/\s+/g, '-').toLowerCase();
-        let reason = '';
-        if (slug.length < APP_SLUG_BASE_MIN_LENGTH) {
-            reason = `name length must be longer than ${APP_SLUG_BASE_MIN_LENGTH} characters; length: ${slug.length}`;
-        }
-        else if (slug.length > APP_SLUG_BASE_MAX_LENGTH) {
-            reason = `name length must be shorter than ${APP_SLUG_BASE_MAX_LENGTH} characters; length: ${slug.length}`;
-        }
-        else if (!ALLOWED_SLUG_REGEX.test(slug)) {
-            reason = 'invalid characters; only use a-z, 0-9, and -';
-        }
-        throw new Error(`App name is not valid. (${reason})`);
+    const err = validateSluggable(str);
+    if (err) {
+        throw new Error(`App name is not valid. (${err})`);
     }
     return str.replace(/\s+/g, '-').toLowerCase();
 }