@php-wasm/scopes 0.1.0 → 0.1.2

package/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+	"extends": ["../../../.eslintrc.json"],
+	"ignorePatterns": ["!**/*"],
+	"overrides": [
+		{
+			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+			"rules": {}
+		},
+		{
+			"files": ["*.ts", "*.tsx"],
+			"rules": {}
+		},
+		{
+			"files": ["*.js", "*.jsx"],
+			"rules": {}
+		}
+	]
+}

package/README.md

@@ -0,0 +1,7 @@
+# php-wasm-scopes
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test php-wasm-scopes` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -1,23 +1,23 @@
 {
-  "name": "@php-wasm/scopes",
-  "version": "0.1.0",
-  "description": "PHP.wasm – scoped URLs utils",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/WordPress/wordpress-playground"
-  },
-  "homepage": "https://developer.wordpress.org/playground",
-  "author": "The WordPress contributors",
-  "contributors": [
-    {
-      "name": "Adam Zielinski",
-      "email": "adam@adamziel.com",
-      "url": "https://github.com/adamziel"
-    }
-  ],
-  "license": "GPL-2.0-or-later",
-  "type": "module",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "dependencies": {}
+	"name": "@php-wasm/scopes",
+	"version": "0.1.2",
+	"description": "PHP.wasm – scoped URLs utils",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WordPress/wordpress-playground"
+	},
+	"homepage": "https://developer.wordpress.org/playground",
+	"author": "The WordPress contributors",
+	"contributors": [
+		{
+			"name": "Adam Zielinski",
+			"email": "adam@adamziel.com",
+			"url": "https://github.com/adamziel"
+		}
+	],
+	"license": "GPL-2.0-or-later",
+	"type": "module",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"gitHead": "a0eeb66fd5386bb56715fca2b89e9669a5b8618b"
 }

package/project.json

@@ -0,0 +1,48 @@
+{
+	"name": "php-wasm-scopes",
+	"$schema": "../../../node_modules/nx/schemas/project-schema.json",
+	"sourceRoot": "packages/php-wasm/scopes/src",
+	"projectType": "library",
+	"targets": {
+		"build": {
+			"executor": "@wp-playground/nx-extensions:package-json",
+			"options": {
+				"tsConfig": "packages/php-wasm/scopes/tsconfig.lib.json",
+				"outputPath": "dist/packages/php-wasm/scopes",
+				"buildTarget": "php-wasm-scopes:build:bundle:production"
+			}
+		},
+		"build:bundle": {
+			"executor": "@nrwl/vite:build",
+			"outputs": ["{options.outputPath}"],
+			"options": {
+				"outputPath": "dist/packages/php-wasm/scopes"
+			}
+		},
+		"lint": {
+			"executor": "@nrwl/linter:eslint",
+			"outputs": ["{options.outputFile}"],
+			"options": {
+				"lintFilePatterns": ["packages/php-wasm/scopes/**/*.ts"]
+			}
+		},
+		"test": {
+			"executor": "@nrwl/vite:test",
+			"outputs": ["coverage/packages/php-wasm/scopes"],
+			"options": {
+				"passWithNoTests": true,
+				"reportsDirectory": "../../../coverage/packages/php-wasm/scopes"
+			}
+		},
+		"typecheck": {
+			"executor": "@nrwl/workspace:run-commands",
+			"options": {
+				"commands": [
+					"yarn tsc -p packages/php-wasm/scopes/tsconfig.lib.json --noEmit",
+					"yarn tsc -p packages/php-wasm/scopes/tsconfig.spec.json --noEmit"
+				]
+			}
+		}
+	},
+	"tags": []
+}

package/src/index.spec.ts

@@ -0,0 +1,58 @@
+import { getURLScope, isURLScoped, removeURLScope, setURLScope } from './index';
+
+describe('getURLScope', () => {
+	it('should return the scope from a scoped URL', () => {
+		const url = new URL('http://localhost/scope:12345/index.php');
+		expect(getURLScope(url)).toBe('12345');
+	});
+
+	it('should return null from a non-scoped URL', () => {
+		const url = new URL('http://localhost/index.php');
+		expect(getURLScope(url)).toBeNull();
+	});
+});
+
+describe('isURLScoped', () => {
+	it('should return true for a scoped URL', () => {
+		const url = new URL('http://localhost/scope:12345/index.php');
+		expect(isURLScoped(url)).toBe(true);
+	});
+
+	it('should return false for a non-scoped URL', () => {
+		const url = new URL('http://localhost/index.php');
+		expect(isURLScoped(url)).toBe(false);
+	});
+});
+
+describe('removeURLScope', () => {
+	it('should remove the scope from a scoped URL', () => {
+		const url = new URL('http://localhost/scope:12345/index.php');
+		expect(removeURLScope(url).href).toBe('http://localhost/index.php');
+	});
+
+	it('should return the same URL for a non-scoped URL', () => {
+		const url = new URL('http://localhost/index.php');
+		expect(removeURLScope(url)).toBe(url);
+	});
+});
+
+describe('setURLScope', () => {
+	it('should add the scope to a non-scoped URL', () => {
+		const url = new URL('http://localhost/index.php');
+		expect(setURLScope(url, '12345').href).toBe(
+			'http://localhost/scope:12345/index.php'
+		);
+	});
+
+	it('should replace the scope in a scoped URL', () => {
+		const url = new URL('http://localhost/scope:12345/index.php');
+		expect(setURLScope(url, '67890').href).toBe(
+			'http://localhost/scope:67890/index.php'
+		);
+	});
+
+	it('should remove the scope from a URL when the scope is null', () => {
+		const url = new URL('http://localhost/scope:12345/index.php');
+		expect(setURLScope(url, null).href).toBe('http://localhost/index.php');
+	});
+});

package/{index.d.ts → src/index.ts}

@@ -11,6 +11,7 @@
  *
  * For more information, see the README section on scopes.
  */
+
 /**
  * Checks if the given URL contains scope information.
  *
@@ -26,7 +27,10 @@
  * @param  url The URL to check.
  * @returns `true` if the URL contains scope information, `false` otherwise.
  */
-export declare function isURLScoped(url: URL): boolean;
+export function isURLScoped(url: URL): boolean {
+	return url.pathname.startsWith(`/scope:`);
+}
+
 /**
  * Returns the scope stored in the given URL.
  *
@@ -42,7 +46,13 @@ export declare function isURLScoped(url: URL): boolean;
  * @param  url The URL.
  * @returns The scope if the URL contains a scope, `null` otherwise.
  */
-export declare function getURLScope(url: URL): string | null;
+export function getURLScope(url: URL): string | null {
+	if (isURLScoped(url)) {
+		return url.pathname.split('/')[1].split(':')[1];
+	}
+	return null;
+}
+
 /**
  * Returns a new URL with the requested scope information.
  *
@@ -62,7 +72,25 @@ export declare function getURLScope(url: URL): string | null;
  * @param  scope The scope value.
  * @returns A new URL with the scope information in it.
  */
-export declare function setURLScope(url: URL | string, scope: string | null): URL;
+export function setURLScope(url: URL | string, scope: string | null): URL {
+	let newUrl = new URL(url);
+
+	if (isURLScoped(newUrl)) {
+		if (scope) {
+			const parts = newUrl.pathname.split('/');
+			parts[1] = `scope:${scope}`;
+			newUrl.pathname = parts.join('/');
+		} else {
+			newUrl = removeURLScope(newUrl);
+		}
+	} else if (scope) {
+		const suffix = newUrl.pathname === '/' ? '' : newUrl.pathname;
+		newUrl.pathname = `/scope:${scope}${suffix}`;
+	}
+
+	return newUrl;
+}
+
 /**
  * Returns a new URL without any scope information.
  *
@@ -78,4 +106,12 @@ export declare function setURLScope(url: URL | string, scope: string | null): UR
  * @param  url The URL to remove scope information from.
  * @returns A new URL without the scope information.
  */
-export declare function removeURLScope(url: URL): URL;
+export function removeURLScope(url: URL): URL {
+	if (!isURLScoped(url)) {
+		return url;
+	}
+	const newUrl = new URL(url);
+	const parts = newUrl.pathname.split('/');
+	newUrl.pathname = '/' + parts.slice(2).join('/');
+	return newUrl;
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+	"extends": "../../../tsconfig.base.json",
+	"compilerOptions": {
+		"forceConsistentCasingInFileNames": true,
+		"strict": true,
+		"noImplicitOverride": true,
+		"noPropertyAccessFromIndexSignature": true,
+		"noImplicitReturns": true,
+		"noFallthroughCasesInSwitch": true,
+		"types": ["vitest"]
+	},
+	"files": [],
+	"include": [],
+	"references": [
+		{
+			"path": "./tsconfig.lib.json"
+		},
+		{
+			"path": "./tsconfig.spec.json"
+		}
+	]
+}

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "../../../dist/out-tsc",
+		"declaration": true,
+		"types": ["node"]
+	},
+	"include": ["src/**/*.ts"],
+	"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,19 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "../../dist/out-tsc",
+		"types": ["vitest/globals", "vitest/importMeta", "vite/client", "node"]
+	},
+	"include": [
+		"vite.config.ts",
+		"src/**/*.test.ts",
+		"src/**/*.spec.ts",
+		"src/**/*.test.tsx",
+		"src/**/*.spec.tsx",
+		"src/**/*.test.js",
+		"src/**/*.spec.js",
+		"src/**/*.test.jsx",
+		"src/**/*.spec.jsx",
+		"src/**/*.d.ts"
+	]
+}

package/vite.config.ts

@@ -0,0 +1,47 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite';
+
+import viteTsConfigPaths from 'vite-tsconfig-paths';
+import dts from 'vite-plugin-dts';
+import { join } from 'path';
+
+export default defineConfig({
+	cacheDir: '../../../node_modules/.vite/php-wasm-scope',
+
+	plugins: [
+		dts({
+			entryRoot: 'src',
+			tsConfigFilePath: join(__dirname, 'tsconfig.lib.json'),
+			skipDiagnostics: true,
+		}),
+
+		viteTsConfigPaths({
+			root: '../../../',
+		}),
+	],
+
+	// Configuration for building your library.
+	// See: https://vitejs.dev/guide/build.html#library-mode
+	build: {
+		lib: {
+			// Could also be a dictionary or array of multiple entry points.
+			entry: 'src/index.ts',
+			name: 'php-wasm-scope',
+			fileName: 'index',
+			formats: ['es'],
+		},
+		rollupOptions: {
+			// External packages that should not be bundled into your library.
+			external: [],
+		},
+	},
+
+	test: {
+		globals: true,
+		cache: {
+			dir: '../../../node_modules/.vitest',
+		},
+		environment: 'jsdom',
+		include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+	},
+});

package/index.js

@@ -1,32 +0,0 @@
-function p(e) {
-  return e.pathname.startsWith("/scope:");
-}
-function s(e) {
-  return p(e) ? e.pathname.split("/")[1].split(":")[1] : null;
-}
-function o(e, n) {
-  let t = new URL(e);
-  if (p(t))
-    if (n) {
-      const a = t.pathname.split("/");
-      a[1] = `scope:${n}`, t.pathname = a.join("/");
-    } else
-      t = i(t);
-  else if (n) {
-    const a = t.pathname === "/" ? "" : t.pathname;
-    t.pathname = `/scope:${n}${a}`;
-  }
-  return t;
-}
-function i(e) {
-  if (!p(e))
-    return e;
-  const n = new URL(e), t = n.pathname.split("/");
-  return n.pathname = "/" + t.slice(2).join("/"), n;
-}
-export {
-  s as getURLScope,
-  p as isURLScoped,
-  i as removeURLScope,
-  o as setURLScope
-};