feat(name): bump name to domain-glossary namespace

changelog.md

@@ -1,5 +1,6 @@
 # Changelog
 
+<<<<<<< Updated upstream
 ## [1.2.0](https://github.com/ehmpathy/uni-phone/compare/v1.1.1...v1.2.0) (2024-12-04)
 
 
@@ -8,29 +9,32 @@
 * **cast:** expose cast asPartialPhoneInHumanWords ([f1efe3d](https://github.com/ehmpathy/uni-phone/commit/f1efe3d79508aeaf9a14e643f928e5f67eae868c))
 
 ## [1.1.1](https://github.com/ehmpathy/uni-phone/compare/v1.1.0...v1.1.1) (2024-12-03)
+=======
+## [1.1.1](https://github.com/ehmpathy/domain-glossary-phone/compare/v1.1.0...v1.1.1) (2024-12-03)
+>>>>>>> Stashed changes
 
 
 ### Bug Fixes
 
-* **pkg:** ensure new cast is exposed on index ([0a1a5c2](https://github.com/ehmpathy/uni-phone/commit/0a1a5c23d72aecb996c3b85cbc48da8043b6f57f))
+* **pkg:** ensure new cast is exposed on index ([0a1a5c2](https://github.com/ehmpathy/domain-glossary-phone/commit/0a1a5c23d72aecb996c3b85cbc48da8043b6f57f))
 
-## [1.1.0](https://github.com/ehmpathy/uni-phone/compare/v1.0.1...v1.1.0) (2024-12-03)
+## [1.1.0](https://github.com/ehmpathy/domain-glossary-phone/compare/v1.0.1...v1.1.0) (2024-12-03)
 
 
 ### Features
 
-* **cast:** cast to phone in human words ([9f2eaea](https://github.com/ehmpathy/uni-phone/commit/9f2eaea0852bc51eee230387aeb5d6b045d3db69))
+* **cast:** cast to phone in human words ([9f2eaea](https://github.com/ehmpathy/domain-glossary-phone/commit/9f2eaea0852bc51eee230387aeb5d6b045d3db69))
 
-## [1.0.1](https://github.com/ehmpathy/uni-phone/compare/v1.0.0...v1.0.1) (2024-12-03)
+## [1.0.1](https://github.com/ehmpathy/domain-glossary-phone/compare/v1.0.0...v1.0.1) (2024-12-03)
 
 
 ### Bug Fixes
 
-* **check:** extend isUniPhoneNumber withAssure ([47f530b](https://github.com/ehmpathy/uni-phone/commit/47f530b76b2c56066895b8162cbcfb608dddf722))
+* **check:** extend isPhoneNumber withAssure ([47f530b](https://github.com/ehmpathy/domain-glossary-phone/commit/47f530b76b2c56066895b8162cbcfb608dddf722))
 
 ## 1.0.0 (2024-11-29)
 
 
 ### Features
 
-* **init:** initialize based on uni-time ([8db8ce5](https://github.com/ehmpathy/uni-phone/commit/8db8ce5ee3b925ebd43aadef4e8b8425d445c227))
+* **init:** initialize based on uni-time ([8db8ce5](https://github.com/ehmpathy/domain-glossary-phone/commit/8db8ce5ee3b925ebd43aadef4e8b8425d445c227))

declapract.use.yml

@@ -3,4 +3,4 @@ declarations: npm:declapract-typescript-ehmpathy
 useCase: npm-package # specify which use case your repo is following, see `declapract-typescript-ehmpathy:src/useCases.yml` for options
 variables: # specify the values of the variables to use against checks
   organizationName: 'ehmpathy'
-  projectName: 'uni-phone'
+  projectName: 'domain-glossary-phone'

package.json

@@ -1,19 +1,15 @@
 {
-  "name": "uni-phone",
+  "name": "domain-glossary-phone",
   "author": "ehmpathy",
-  "description": "a glossary of universally intuitive time, date, and duration domain literals",
+  "description": "A glossary of intuitive, universally unambiguous phone definitions and useful procedures.",
   "version": "1.2.0",
-  "repository": "ehmpathy/uni-phone",
-  "homepage": "https://github.com/ehmpathy/uni-phone",
+  "repository": "ehmpathy/domain-glossary-phone",
+  "homepage": "https://github.com/ehmpathy/domain-glossary-phone",
   "keywords": [
-    "time",
-    "date",
-    "datetime",
-    "UniDate",
-    "UniDateTime",
-    "UniDuration"
+    "phone",
+    "phone number"
   ],
-  "bugs": "https://github.com/ehmpathy/uni-phone/issues",
+  "bugs": "https://github.com/ehmpathy/domain-glossary-phone/issues",
   "license": "MIT",
   "main": "dist/index.js",
   "engines": {

readme.md

@@ -1,26 +1,26 @@
-# uni-phone
+# domain-glossary-phone
 
-![test](https://github.com/ehmpathy/uni-phone/workflows/test/badge.svg)
-![publish](https://github.com/ehmpathy/uni-phone/workflows/publish/badge.svg)
+![test](https://github.com/ehmpathy/domain-glossary-phone/workflows/test/badge.svg)
+![publish](https://github.com/ehmpathy/domain-glossary-phone/workflows/publish/badge.svg)
 
-A glossary of intuitive, universally unambiguous phone domain literals.
+A glossary of intuitive, universally unambiguous phone definitions and useful procedures.
 
 # purpose
 
 declare a universally unambiguous serialization format for phones
-- `UniPhoneNumber` = [E.164](https://en.wikipedia.org/wiki/E.164)
-- `UniPhone` = `{ number: UniPhoneNumber }`
+- `PhoneNumber` = [E.164](https://en.wikipedia.org/wiki/E.164)
+- `Phone` = `{ number: PhoneNumber }`
 
 usecases
-- clarify the format a string should be in (`const phoneNumber: UniPhoneNumber = '+13231110101'`)
-- cast date to universal format (`const phoneNumber: UniPhoneNumber = toUniPhoneNumber('(323) 111-0101')`)
-- narrow type of strings with runtime validation (`if (!isUniPhoneNumber(input)) throw new Error('wrong format')`)
+- clarify the format a string should be in (`const phoneNumber: PhoneNumber = '+13231110101'`)
+- cast date to universal format (`const phoneNumber: PhoneNumber = toPhoneNumber('(323) 111-0101')`)
+- narrow type of strings with runtime validation (`if (!isPhoneNumber(input)) throw new Error('wrong format')`)
 
 
 # install
 
 ```sh
-npm install uni-phone
+npm install domain-glossary-phone
 ```
 
 # use
@@ -30,21 +30,21 @@ npm install uni-phone
 ### declare that a phone or phone.number must be in the universal format
 
 ```ts
-const phone: UniPhone;
-const phoneNumber: UniPhoneNumber;
+const phone: Phone;
+const phoneNumber: PhoneNumber;
 ```
 
 
 ### assure that a phone number is in the universal phormat
 
 ```ts
-const phone: UniPhone = { number: isUniPhoneNumber.assure('+13231110101') }
+const phone: Phone = { number: isPhoneNumber.assure('+13231110101') }
 ```
 
 
 ### cast a phone number into the universal format
 
 ```ts
-const phone: UniPhone = { number: asUniPhoneNumber('(323) 111-0101') }
+const phone: Phone = { number: asPhoneNumber('(323) 111-0101') }
 ```
 

src/PhoneNumber.ts

@@ -0,0 +1,10 @@
+import { AsOfGlossary } from 'domain-glossaries';
+
+/**
+ * a phone number, any format
+ * - e.g., (317) 111-3333
+ */
+export type PhoneNumber = AsOfGlossary<
+  string,
+  'domain-glossary-phone.PhoneNumber'
+>;

src/UniPhone.ts

@@ -1,7 +1,16 @@
 import { DomainLiteral } from 'domain-objects';
 
+import { UniPhoneNumber } from './UniPhoneNumber';
+
+/**
+ * .what = a universal phone declaration
+ */
 export interface UniPhone {
   id?: number;
-  number: string;
+
+  /**
+   * always declare in terms of uni phone number, to make phone universal
+   */
+  number: UniPhoneNumber;
 }
 export class UniPhone extends DomainLiteral<UniPhone> implements UniPhone {}

src/UniPhoneNumber.ts

@@ -4,4 +4,7 @@ import { AsOfGlossary } from 'domain-glossaries';
  * a phone number in the universal E.164 format
  * - E.164 example: +18175698900
  */
-export type UniPhoneNumber = AsOfGlossary<string, 'uni-phone'>;
+export type UniPhoneNumber = AsOfGlossary<
+  string,
+  'domain-glossary-phone.UniPhoneNumber'
+>;

src/asUniPhoneInHumanWords.ts

@@ -12,7 +12,7 @@ export const asUniPhoneInHumanWords = (input: UniPhone): string => {
 
   if (!match) {
     throw new Error(
-      'Invalid UniPhone format. Expected format: +<country-code><10-digit-phone>',
+      'Invalid Phone format. Expected format: +<country-code><10-digit-phone>',
     );
   }
 

src/asUniPhoneNumber.ts

@@ -10,7 +10,7 @@ export const asUniPhoneNumber = (input: string): UniPhoneNumber => {
   const { phoneNumber: normalizedPhoneNumber } = phone(input);
   if (!normalizedPhoneNumber)
     throw new UnexpectedCodePathError(
-      'input was not a valid phone number. can not be cast to uni-phone-number',
+      'input was not a valid phone number. can not be cast to domain-glossary-phone-number',
       { input },
     );
   return normalizedPhoneNumber as UniPhoneNumber;

src/index.ts

@@ -1,7 +1,7 @@
 export * from './UniPhoneNumber';
-export * from './isUniPhoneNumber';
-export * from './asUniPhoneNumber';
 export * from './isPhoneNumber';
+export * from './asUniPhoneNumber';
+export * from './isUniPhoneNumber';
 export * from './UniPhone';
 export * from './asUniPhoneInHumanWords';
 export * from './asPartialPhoneInHumanWords';