@lightdash/common 2.272.2 → 2.273.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,4 +2,11 @@ import { z } from 'zod';
2
2
  export declare const validateOrganizationName: (name: string) => boolean;
3
3
  export declare const getOrganizationNameSchema: () => z.ZodString;
4
4
  export declare const validateOrganizationNameOrThrow: (name: string) => void;
5
+ export declare const sanitizeOrganizationName: (name: string, fallback: string) => string;
6
+ export type InvalidOrganizationNameMessage = {
7
+ title: string;
8
+ body: string;
9
+ };
10
+ export declare const describeInvalidOrganizationName: (name: string) => InvalidOrganizationNameMessage;
11
+ export declare const suggestOrganizationName: (name: string) => string | null;
5
12
  //# sourceMappingURL=organization.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"organization.d.ts","sourceRoot":"","sources":["../../../src/utils/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,wBAAwB,SAAU,MAAM,YAOpD,CAAC;AAEF,eAAO,MAAM,yBAAyB,mBAIhC,CAAC;AAEP,eAAO,MAAM,+BAA+B,SAAU,MAAM,SAU3D,CAAC"}
1
+ {"version":3,"file":"organization.d.ts","sourceRoot":"","sources":["../../../src/utils/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,wBAAwB,SAAU,MAAM,YAOpD,CAAC;AAEF,eAAO,MAAM,yBAAyB,mBAIhC,CAAC;AAEP,eAAO,MAAM,+BAA+B,SAAU,MAAM,SAU3D,CAAC;AAOF,eAAO,MAAM,wBAAwB,SAC3B,MAAM,YACF,MAAM,KACjB,MAiBF,CAAC;AAoCF,MAAM,MAAM,8BAA8B,GAAG;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF,eAAO,MAAM,+BAA+B,SAClC,MAAM,KACb,8BAgCF,CAAC;AAEF,eAAO,MAAM,uBAAuB,SAAU,MAAM,KAAG,MAAM,GAAG,IAK/D,CAAC"}
@@ -20,4 +20,94 @@ export const validateOrganizationNameOrThrow = (name) => {
20
20
  throw new ParameterError(parsedOrganizationName.error.message);
21
21
  }
22
22
  };
23
+ const APOSTROPHE_LIKE = new Set(["'", '\u2019', '`']);
24
+ const foldCombiningMarks = (value) => value.normalize('NFKD').replace(/\p{M}/gu, '');
25
+ export const sanitizeOrganizationName = (name, fallback) => {
26
+ if (validateOrganizationName(name))
27
+ return name.trim();
28
+ const withoutAccents = foldCombiningMarks(name);
29
+ const replaced = Array.from(withoutAccents)
30
+ .map((character) => {
31
+ if (character === ' ')
32
+ return character;
33
+ if (validateOrganizationName(character))
34
+ return character;
35
+ if (APOSTROPHE_LIKE.has(character))
36
+ return '';
37
+ return ' ';
38
+ })
39
+ .join('');
40
+ const collapsed = replaced.replace(/\s+/g, ' ').trim();
41
+ return validateOrganizationName(collapsed) ? collapsed : fallback;
42
+ };
43
+ const INVALID_CHARACTER_KINDS = new Map([
44
+ ['.', 'periods'],
45
+ [',', 'commas'],
46
+ ["'", 'apostrophes'],
47
+ ['’', 'apostrophes'],
48
+ ['`', 'apostrophes'],
49
+ ['&', 'ampersands'],
50
+ ['/', 'slashes'],
51
+ ['\\', 'slashes'],
52
+ [':', 'colons'],
53
+ [';', 'semicolons'],
54
+ ['!', 'exclamation marks'],
55
+ ['?', 'question marks'],
56
+ ['"', 'quotation marks'],
57
+ ['“', 'quotation marks'],
58
+ ['”', 'quotation marks'],
59
+ ['(', 'parentheses'],
60
+ [')', 'parentheses'],
61
+ ['[', 'brackets'],
62
+ [']', 'brackets'],
63
+ ['+', 'plus signs'],
64
+ ['*', 'asterisks'],
65
+ ['#', 'hash signs'],
66
+ ['@', 'at signs'],
67
+ ['%', 'percent signs'],
68
+ ['$', 'dollar signs'],
69
+ ]);
70
+ const invalidCharacterKind = (character) => {
71
+ const folded = foldCombiningMarks(character);
72
+ if (/^[A-Za-z]+$/.test(folded))
73
+ return 'accented characters';
74
+ return INVALID_CHARACTER_KINDS.get(character) ?? null;
75
+ };
76
+ const INVALID_ORGANIZATION_NAME_BODY = 'Use letters, numbers, spaces, hyphens or underscores.';
77
+ export const describeInvalidOrganizationName = (name) => {
78
+ if (name.trim() === '') {
79
+ return {
80
+ title: 'Enter an organization name',
81
+ body: INVALID_ORGANIZATION_NAME_BODY,
82
+ };
83
+ }
84
+ const kinds = new Set();
85
+ let hasUnmappedCharacter = false;
86
+ new Set(Array.from(name)).forEach((character) => {
87
+ if (character === ' ' || validateOrganizationName(character))
88
+ return;
89
+ const kind = invalidCharacterKind(character);
90
+ if (kind === null)
91
+ hasUnmappedCharacter = true;
92
+ else
93
+ kinds.add(kind);
94
+ });
95
+ if (kinds.size === 1 && !hasUnmappedCharacter) {
96
+ const [kind] = Array.from(kinds);
97
+ return {
98
+ title: `${kind.charAt(0).toUpperCase()}${kind.slice(1)} aren't allowed`,
99
+ body: INVALID_ORGANIZATION_NAME_BODY,
100
+ };
101
+ }
102
+ return {
103
+ title: "That name has characters we can't use",
104
+ body: INVALID_ORGANIZATION_NAME_BODY,
105
+ };
106
+ };
107
+ export const suggestOrganizationName = (name) => {
108
+ const suggestion = sanitizeOrganizationName(name, '');
109
+ return validateOrganizationName(suggestion) && suggestion !== name.trim()
110
+ ? suggestion
111
+ : null;
112
+ };
23
113
  //# sourceMappingURL=organization.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"organization.js","sourceRoot":"","sources":["../../../src/utils/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,IAAY,EAAE,EAAE;IACrD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAEhC,IAAI,WAAW,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAErC,MAAM,OAAO,GAAG,mBAAmB,CAAC;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,EAAE,CAC1C,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,wBAAwB,EAAE;IAC/C,OAAO,EACH,6GAA6G;CACpH,CAAC,CAAC;AAEP,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,IAAY,EAAE,EAAE;IAC5D,MAAM,sBAAsB,GAAG,yBAAyB,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAE3E,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1B,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,IAAI,cAAc,CAAC,sBAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;AACL,CAAC,CAAC"}
1
+ {"version":3,"file":"organization.js","sourceRoot":"","sources":["../../../src/utils/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,IAAY,EAAE,EAAE;IACrD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAEhC,IAAI,WAAW,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAErC,MAAM,OAAO,GAAG,mBAAmB,CAAC;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,EAAE,CAC1C,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,wBAAwB,EAAE;IAC/C,OAAO,EACH,6GAA6G;CACpH,CAAC,CAAC;AAEP,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,IAAY,EAAE,EAAE;IAC5D,MAAM,sBAAsB,GAAG,yBAAyB,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAE3E,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1B,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,IAAI,cAAc,CAAC,sBAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAEtD,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAU,EAAE,CACjD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;AAEnD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACpC,IAAY,EACZ,QAAgB,EACV,EAAE;IACR,IAAI,wBAAwB,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IAEvD,MAAM,cAAc,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAEhD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC;SACtC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QACf,IAAI,SAAS,KAAK,GAAG;YAAE,OAAO,SAAS,CAAC;QACxC,IAAI,wBAAwB,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;QAC1D,IAAI,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,OAAO,EAAE,CAAC;QAC9C,OAAO,GAAG,CAAC;IACf,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;IAEd,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAEvD,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAiB;IACpD,CAAC,GAAG,EAAE,SAAS,CAAC;IAChB,CAAC,GAAG,EAAE,QAAQ,CAAC;IACf,CAAC,GAAG,EAAE,aAAa,CAAC;IACpB,CAAC,GAAG,EAAE,aAAa,CAAC;IACpB,CAAC,GAAG,EAAE,aAAa,CAAC;IACpB,CAAC,GAAG,EAAE,YAAY,CAAC;IACnB,CAAC,GAAG,EAAE,SAAS,CAAC;IAChB,CAAC,IAAI,EAAE,SAAS,CAAC;IACjB,CAAC,GAAG,EAAE,QAAQ,CAAC;IACf,CAAC,GAAG,EAAE,YAAY,CAAC;IACnB,CAAC,GAAG,EAAE,mBAAmB,CAAC;IAC1B,CAAC,GAAG,EAAE,gBAAgB,CAAC;IACvB,CAAC,GAAG,EAAE,iBAAiB,CAAC;IACxB,CAAC,GAAG,EAAE,iBAAiB,CAAC;IACxB,CAAC,GAAG,EAAE,iBAAiB,CAAC;IACxB,CAAC,GAAG,EAAE,aAAa,CAAC;IACpB,CAAC,GAAG,EAAE,aAAa,CAAC;IACpB,CAAC,GAAG,EAAE,UAAU,CAAC;IACjB,CAAC,GAAG,EAAE,UAAU,CAAC;IACjB,CAAC,GAAG,EAAE,YAAY,CAAC;IACnB,CAAC,GAAG,EAAE,WAAW,CAAC;IAClB,CAAC,GAAG,EAAE,YAAY,CAAC;IACnB,CAAC,GAAG,EAAE,UAAU,CAAC;IACjB,CAAC,GAAG,EAAE,eAAe,CAAC;IACtB,CAAC,GAAG,EAAE,cAAc,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAiB,EAAE;IAC9D,MAAM,MAAM,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC7C,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,qBAAqB,CAAC;IAC7D,OAAO,uBAAuB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;AAC1D,CAAC,CAAC;AAOF,MAAM,8BAA8B,GAChC,uDAAuD,CAAC;AAE5D,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAC3C,IAAY,EACkB,EAAE;IAChC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrB,OAAO;YACH,KAAK,EAAE,4BAA4B;YACnC,IAAI,EAAE,8BAA8B;SACvC,CAAC;IACN,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,IAAI,oBAAoB,GAAG,KAAK,CAAC;IAEjC,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;QAC5C,IAAI,SAAS,KAAK,GAAG,IAAI,wBAAwB,CAAC,SAAS,CAAC;YAAE,OAAO;QACrE,MAAM,IAAI,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,IAAI,KAAK,IAAI;YAAE,oBAAoB,GAAG,IAAI,CAAC;;YAC1C,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5C,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO;YACH,KAAK,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAC/C,CAAC,CACJ,iBAAiB;YAClB,IAAI,EAAE,8BAA8B;SACvC,CAAC;IACN,CAAC;IAED,OAAO;QACH,KAAK,EAAE,uCAAuC;QAC9C,IAAI,EAAE,8BAA8B;KACvC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAY,EAAiB,EAAE;IACnE,MAAM,UAAU,GAAG,wBAAwB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACtD,OAAO,wBAAwB,CAAC,UAAU,CAAC,IAAI,UAAU,KAAK,IAAI,CAAC,IAAI,EAAE;QACrE,CAAC,CAAC,UAAU;QACZ,CAAC,CAAC,IAAI,CAAC;AACf,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lightdash/common",
3
- "version": "2.272.2",
3
+ "version": "2.273.0",
4
4
  "license": "MIT",
5
5
  "repository": {
6
6
  "type": "git",