create-kitql - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4-next.0

bin.js

@@ -5,6 +5,6 @@ #!/usr/bin/env node
 import { program, Option } from 'commander'
-import fs, { readFileSync } from 'node:fs'
-import path from 'node:path'
-import { exit } from 'node:process'
-import { fileURLToPath } from 'node:url'
+import fs from 'fs'
+import path from 'path'
+import { exit } from 'process'
+import { fileURLToPath } from 'url'
 
@@ -25,3 +25,3 @@ const { version } = JSON.parse(fs.readFileSync(new URL('package.json', import.meta.url), 'utf-8'))
     if (fs.existsSync(metaPath)) {
-      data = JSON.parse(readFileSync(metaPath, 'utf-8'))
+      data = JSON.parse(fs.readFileSync(metaPath, 'utf-8'))
     }
@@ -28,0 +28,0 @@ return { ...data, value: templateDir }

package.json

@@ -9,3 +9,3 @@ {
   ],
-  "version": "0.0.3",
+  "version": "0.0.4-next.0",
   "license": "MIT",
@@ -12,0 +12,0 @@ "type": "module",

templates/kit-routes/package.json

@@ -32,4 +32,4 @@ {
 		"typescript": "^5.0.0",
-		"vite": "^4.4.2",
-		"vite-plugin-kit-routes": "^0.1.1",
+		"vite": "^4.5.0",
+		"vite-plugin-kit-routes": "0.2.0-next.1",
 		"vitest": "^0.34.0"
@@ -36,0 +36,0 @@ },

templates/kit-routes/src/lib/ROUTES.ts

@@ -7,3 +7,6 @@ /**
 
-export const PAGES = {
+/**
+ * PAGES
+ */
+const PAGES = {
 	'/': `/`,
@@ -14,7 +17,16 @@ '/about': `/about`,
 
-export const SERVERS = {};
+/**
+ * SERVERS
+ */
+const SERVERS = {};
 
-export const ACTIONS = {};
+/**
+ * ACTIONS
+ */
+const ACTIONS = {};
 
-export const LINKS = {
+/**
+ * LINKS
+ */
+const LINKS = {
 	twitter: `https:/twitter.com/jycouet`,
@@ -28,7 +40,13 @@ github: `https:/github.com/jycouet/kitql`,
 		params.d = params.d ?? 'identicon';
-		return `https:/www.gravatar.com/avatar/${params.str}${appendSp({ s: params.s, d: params.d })}`;
+		return `https:/www.gravatar.com/avatar/${params.str}${appendSp({
+			s: params?.s,
+			d: params?.d
+		})}`;
 	}
 };
 
-const appendSp = (sp?: Record<string, string | number | undefined>) => {
+/**
+ * Append search params to a string
+ */
+const appendSp = (sp?: Record<string, string | number | undefined>, prefix: '?' | '&' = '?') => {
 	if (sp === undefined) return '';
@@ -41,3 +59,3 @@ const mapping = Object.entries(sp)
 	if (formated) {
-		return `?${formated}`;
+		return `${prefix}${formated}`;
 	}
@@ -47,3 +65,33 @@ return '';
 
+// route function helpers
+type NonFunctionKeys<T> = { [K in keyof T]: T[K] extends Function ? never : K }[keyof T];
+type FunctionKeys<T> = { [K in keyof T]: T[K] extends Function ? K : never }[keyof T];
+type FunctionParams<T> = T extends (...args: infer P) => any ? P : never;
+
+const AllObjs = { ...PAGES, ...ACTIONS, ...SERVERS, ...LINKS };
+type AllTypes = typeof AllObjs;
+
 /**
+ * To be used like this:
+ * ```ts
+ * import { route } from './ROUTES'
+ *
+ * route('site_id', { id: 1 })
+ * ```
+ */
+export function route<T extends FunctionKeys<AllTypes>>(
+	key: T,
+	...params: FunctionParams<AllTypes[T]>
+): string;
+export function route<T extends NonFunctionKeys<AllTypes>>(key: T): string;
+export function route<T extends keyof AllTypes>(key: T, ...params: any[]): string {
+	if (AllObjs[key] instanceof Function) {
+		const element = (AllObjs as any)[key] as (...args: any[]) => string;
+		return element(...params);
+	} else {
+		return AllObjs[key] as string;
+	}
+}
+
+/**
  * Add this type as a generic of the vite plugin `kitRoutes<KIT_ROUTES>`.
@@ -58,3 +106,3 @@ *
  *  PAGES: {
- *    // here, "paths" it will be typed!
+ *    // here, key of object will be typed!
  *  }
@@ -66,6 +114,6 @@ * })
 	PAGES: { '/': never; '/about': never; '/your-face': never };
-	SERVERS: {};
-	ACTIONS: {};
+	SERVERS: Record<string, never>;
+	ACTIONS: Record<string, never>;
 	LINKS: { twitter: never; github: never; github_avatar: 'author'; gravatar: 'str' };
 	Params: { author: never; str: never; s: never; d: never };
 };

templates/kitql-remult/package.json

@@ -33,3 +33,3 @@ {
 		"typescript": "^5.0.0",
-		"vite": "^4.4.2",
+		"vite": "^4.5.0",
 		"vite-plugin-kit-routes": "^0.1.1",
@@ -36,0 +36,0 @@ "vitest": "^0.34.0"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

67416

decreased by-79.9%

Number of package files

53

decreased by-3.64%

Lines of code

629

decreased by-93.04%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes