@one-format/strings-plugin 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,53 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @one-format/strings-plugin
+
+An official one-format plugin for common string transformations.
+
+## Installation
+
+```bash
+npm install @one-format/strings-plugin
+```
+
+## Usage
+
+The package exports a plugin object containing three tools:
+
+```ts
+import stringsPlugin from "@one-format/strings-plugin";
+
+stringsPlugin.tools.uppercase("hello, world!");
+// "HELLO, WORLD!"
+
+stringsPlugin.tools.lowercase("Hello, World!");
+// "hello, world!"
+
+stringsPlugin.tools.urlencoded("hello world!");
+// "hello%20world!"
+```
+
+Use the plugin with `@one-format/core` to expose its tools directly:
+
+```ts
+import adapter from "@one-format/core";
+import stringsPlugin from "@one-format/strings-plugin";
+
+const strings = adapter(stringsPlugin);
+
+strings.uppercase("hello"); // "HELLO"
+strings.lowercase("HELLO"); // "hello"
+strings.urlencoded("hello world"); // "hello%20world"
+```
+
+## API
+
+- `tools.uppercase(value)` - returns the string converted to uppercase.
+- `tools.lowercase(value)` - returns the string converted to lowercase.
+- `tools.urlencoded(value)` - returns the string encoded with
+  `encodeURIComponent`.
+- `metadata` - identifies the plugin and its version.
+
+All tools accept a string and return a string.
+
+## License
+
+EUPL-1.2

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+type PluginFn<Input = any, Output = any> = (input: Input) => Output;
+interface PluginMetadata {
+    name: string;
+    author: string;
+    version?: string;
+}
+interface PluginType<Tools extends Record<string, any>> {
+    metadata: PluginMetadata;
+    tools: {
+        [K in keyof Tools]: PluginFn<Tools[K]['input'], Tools[K]['output']>;
+    };
+}
+declare const stringsPlugin: PluginType<{
+    uppercase: {
+        input: string;
+        output: string;
+    };
+    lowercase: {
+        input: string;
+        output: string;
+    };
+    urlencoded: {
+        input: string;
+        output: string;
+    };
+}>;
+export default stringsPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,KAAK,QAAQ,CAAC,KAAK,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;AAEpE,UAAU,cAAc;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AACD,UAAU,UAAU,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAClD,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE;SACF,CAAC,IAAI,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KACtE,CAAC;CACL;AAGD,QAAA,MAAM,aAAa,EAAE,UAAU,CAAC;IAC5B,SAAS,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAA;KACjB,CAAC;IACF,SAAS,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAA;KACjB,CAAC;IACF,UAAU,EAAE;QACR,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAA;KACjB,CAAA;CACA,CAWJ,CAAA;eAEc,aAAa"}

package/dist/index.js

@@ -0,0 +1,14 @@
+const stringsPlugin = {
+    "metadata": {
+        "author": "Vedansh Shetti <vedansh.shetti@gmail.com> - one-format Official Plugin",
+        "name": "One-Format Strings",
+        "version": "1.1.0"
+    },
+    tools: {
+        uppercase: (s) => s.toUpperCase(),
+        lowercase: (s) => s.toLowerCase(),
+        urlencoded: (s) => encodeURIComponent(s)
+    }
+};
+export default stringsPlugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,MAAM,aAAa,GAaV;IACL,UAAU,EAAE;QACR,QAAQ,EAAE,wEAAwE;QAClF,MAAM,EAAE,oBAAoB;QAC5B,SAAS,EAAE,OAAO;KACrB;IACD,KAAK,EAAE;QACH,SAAS,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE;QACzC,SAAS,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE;QACzC,UAAU,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;KACnD;CACJ,CAAA;AAED,eAAe,aAAa,CAAC"}

package/package.json

@@ -1,6 +1,22 @@
-{
-  "name": "@one-format/strings-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@one-format/strings-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "keywords": [
+    "http-formatting"
+  ],
+  "license": "EUPL-1.2",
+  "author": "Vedansh Shetti <vedansh.shetti@gmail.com>",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"I didnt feel like writing tests, its just more code to maintain\"",
+    "prepublishOnly": "tsc",
+    "postpublish": "rimraf dist"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.5",
+    "rimraf": "^6.1.3",
+    "typescript": "^7.0.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,42 @@
+type PluginFn<Input = any, Output = any> = (input: Input) => Output;
+
+interface PluginMetadata {
+    name: string; // Plugin Name
+    author: string; // Author
+    version?: string; // Version Number, preferably SemVer.
+}
+interface PluginType<Tools extends Record<string, any>> {
+    metadata: PluginMetadata;
+    tools: {
+        [K in keyof Tools]: PluginFn<Tools[K]['input'], Tools[K]['output']>;
+    };
+}
+
+
+const stringsPlugin: PluginType<{
+    uppercase: {
+        input: string,
+        output: string
+    },
+    lowercase: {
+        input: string,
+        output: string
+    },
+    urlencoded: {
+        input: string,
+        output: string
+    }
+    }> = {
+    "metadata": {
+        "author": "Vedansh Shetti <vedansh.shetti@gmail.com> - one-format Official Plugin",
+        "name": "One-Format Strings",
+        "version": "1.1.0"
+    },
+    tools: {
+        uppercase: (s: string) => s.toUpperCase(),
+        lowercase: (s: string) => s.toLowerCase(),
+        urlencoded: (s: string) => encodeURIComponent(s)
+    }
+}
+
+export default stringsPlugin;

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    // Environment Settings
+    "module": "nodenext",
+    "target": "esnext",
+    "lib": ["esnext"],
+    "types": ["node"],
+    
+    // Output Layout
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "noImplicitReturns": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true,
+
+    // Module & Syntax
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}