@dolthub/proto-resource-utils 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,93 @@
+type FromResourceOptions = {
+    validate?: boolean;
+    throwValidationError?: boolean;
+};
+type ToResourceOptions = FromResourceOptions;
+type ResourceNameConverter<T> = {
+    toParams: (resourceName: string, opts?: Partial<FromResourceOptions>) => T;
+    fromParams: (resourceParams: T, opts?: Partial<ToResourceOptions>) => string;
+    validate: (resourceName: string) => boolean;
+    getValidationRegex: () => RegExp;
+    getValidationPattern: () => string;
+};
+
+type NamedResource$3 = {
+    name: string;
+    displayName?: string;
+};
+type Comparator<O extends NamedResource$3> = (t1: O, t2: O) => number;
+type Comparators<O extends NamedResource$3> = {
+    byName: Comparator<O>;
+    byResourceName: Comparator<O>;
+    [fnName: string]: Comparator<O>;
+};
+type Sorter<O extends NamedResource$3> = (ts: O[], desc?: boolean) => O[];
+type Sorters<O extends NamedResource$3> = {
+    [K in keyof Comparators<O>]: Sorter<O>;
+};
+type Objectable<O> = {
+    toObject: () => O;
+};
+type NamedObjectable<O extends NamedResource$3> = {
+    getDisplayName?: () => string;
+    getName: () => string;
+} & Objectable<O>;
+type ResourceUtils<O extends NamedResource$3, T extends NamedObjectable<O>, P extends object, U extends object = object> = {
+    cmp: Comparators<O>;
+    rn: ResourceNameConverter<P>;
+    sort: Sorters<O>;
+    displayName: (r: T | O) => string;
+    fromObject: (o: Partial<O>) => T;
+} & U;
+
+type NamedResource$2 = {
+    name: string;
+};
+declare function byHash(o1: NamedResource$2, o2: NamedResource$2): number;
+
+type NamedResource$1 = {
+    name: string;
+};
+declare function byName(o1: NamedResource$1, o2: NamedResource$1): number;
+
+type NamedResource = {
+    name: string;
+};
+declare function byResourceName(o1: NamedResource, o2: NamedResource): number;
+
+declare function comparatorsToSorters<T extends NamedResource$3>(cmps: Comparators<T>): Sorters<T>;
+
+declare function displayName<O extends NamedObjectable<NamedResource$3>>(r: O | NamedResource$3): string;
+
+declare function doNameValidation<T>(resourceName: string, resourceTypeName: string, converter: ResourceNameConverter<T>, o?: Partial<FromResourceOptions>): void;
+
+declare function doParamValidation(obj: {
+    [paramName: string]: string;
+}, resourceTypeName: string, getValidator: (paramName: string) => (value: string) => boolean, o?: Partial<ToResourceOptions>): void;
+declare class ResourceParamValidationError extends Error {
+}
+
+declare const validResourceSegmentPattern = "[-a-zA-Z0-9_]{3,32}";
+declare const validClientCredentialIdPattern = "[0-9a-v]{45}";
+declare const validEmailPattern = "[a-zA-Z0-9.!#$%&\u2019*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*";
+declare const validEmailOrResourcePattern = "([a-zA-Z0-9.!#$%&\u2019*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*|[-a-zA-Z0-9_]{3,32})";
+declare const validNumberPattern = "[1-9][0-9]*";
+declare const validLongResourcePattern = "[-a-zA-Z0-9_]{3,36}";
+declare const validUuidPattern = "[a-f0-9-]{36}";
+declare const validBackupIdPattern = "[0-9]{8}T[0-9]{6}.[0-9]{3}";
+declare const validBranchNamePattern: string;
+
+declare const validResourceSegmentPattern_d_validBackupIdPattern: typeof validBackupIdPattern;
+declare const validResourceSegmentPattern_d_validBranchNamePattern: typeof validBranchNamePattern;
+declare const validResourceSegmentPattern_d_validClientCredentialIdPattern: typeof validClientCredentialIdPattern;
+declare const validResourceSegmentPattern_d_validEmailOrResourcePattern: typeof validEmailOrResourcePattern;
+declare const validResourceSegmentPattern_d_validEmailPattern: typeof validEmailPattern;
+declare const validResourceSegmentPattern_d_validLongResourcePattern: typeof validLongResourcePattern;
+declare const validResourceSegmentPattern_d_validNumberPattern: typeof validNumberPattern;
+declare const validResourceSegmentPattern_d_validResourceSegmentPattern: typeof validResourceSegmentPattern;
+declare const validResourceSegmentPattern_d_validUuidPattern: typeof validUuidPattern;
+declare namespace validResourceSegmentPattern_d {
+  export { validResourceSegmentPattern_d_validBackupIdPattern as validBackupIdPattern, validResourceSegmentPattern_d_validBranchNamePattern as validBranchNamePattern, validResourceSegmentPattern_d_validClientCredentialIdPattern as validClientCredentialIdPattern, validResourceSegmentPattern_d_validEmailOrResourcePattern as validEmailOrResourcePattern, validResourceSegmentPattern_d_validEmailPattern as validEmailPattern, validResourceSegmentPattern_d_validLongResourcePattern as validLongResourcePattern, validResourceSegmentPattern_d_validNumberPattern as validNumberPattern, validResourceSegmentPattern_d_validResourceSegmentPattern as validResourceSegmentPattern, validResourceSegmentPattern_d_validUuidPattern as validUuidPattern };
+}
+
+export { type Comparators, type NamedResource$3 as NamedResource, type ResourceNameConverter, ResourceParamValidationError, type ResourceUtils, type Sorter, type Sorters, type ToResourceOptions, byHash, byName, byResourceName, comparatorsToSorters, displayName, doNameValidation, doParamValidation, validResourceSegmentPattern_d as validResourceSegmentPattern };

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@dolthub/proto-resource-utils",
+  "author": "DoltHub",
+  "description": "Utilities for handling Google protobuf resources and names",
+  "version": "0.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "web",
+    "utils",
+    "frontend"
+  ],
+  "packageManager": "yarn@4.0.2",
+  "scripts": {
+    "compile": "tsc -b",
+    "build": "rollup -c --bundleConfigAsCjs",
+    "dbuild": "yarn compile && yarn build",
+    "lint": "eslint --cache --ext .ts,.js,.tsx,.jsx src",
+    "prettier": "prettier --check 'src/**/*.{js,ts}'",
+    "prettier-fix": "prettier --write 'src/**/*.{js,ts}'",
+    "npm:publish": "yarn dbuild && npm publish",
+    "test": "jest",
+    "yalc:publish": "yarn dbuild && yalc publish",
+    "yalc:push": "yarn dbuild && yalc push"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.23.7",
+    "@babel/preset-env": "^7.23.8",
+    "@babel/preset-typescript": "^7.23.3",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/eslint": "^8",
+    "@types/jest": "^29.5.11",
+    "@types/lodash": "^4",
+    "@types/rollup-plugin-peer-deps-external": "^2",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "babel-jest": "^29.7.0",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.0",
+    "rollup": "^4.9.4",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-terser": "^7.0.2",
+    "typescript": "^5.3.3",
+    "yalc": "^1.0.0-pre.53"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dolthub/react-library.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dolthub/react-library/issues"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21"
+  }
+}