@kubun/connector-google-contacts 0.8.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/lib/actions.d.ts

@@ -0,0 +1,9 @@
+import type { ActionHandler } from '@kubun/connector';
+export type GoogleContactsActionHandlerConfig = {
+    credential: {
+        accessToken: string;
+        scopes: Array<string>;
+    };
+    fetch?: typeof globalThis.fetch;
+};
+export declare function createGoogleContactsActionHandler(config: GoogleContactsActionHandlerConfig): ActionHandler;

package/lib/actions.js

@@ -0,0 +1 @@
+import{createContact as e,updateContact as c}from"./api.js";export function createGoogleContactsActionHandler(t){return{create:async(c,a)=>e({accessToken:t.credential.accessToken,params:a,fetch:t.fetch}),update:async(e,a,n)=>c({accessToken:t.credential.accessToken,sourceID:a,params:n,fetch:t.fetch})}}

package/lib/api.d.ts

@@ -0,0 +1,49 @@
+import type { EntityRecord } from '@kubun/connector';
+export type GooglePersonResource = {
+    resourceName: string;
+    etag?: string;
+    names?: Array<{
+        displayName?: string;
+        givenName?: string;
+        familyName?: string;
+    }>;
+    emailAddresses?: Array<{
+        value?: string;
+    }>;
+    phoneNumbers?: Array<{
+        value?: string;
+    }>;
+    organizations?: Array<{
+        name?: string;
+        title?: string;
+    }>;
+    photos?: Array<{
+        url?: string;
+    }>;
+};
+export type GoogleConnectionsResponse = {
+    connections?: Array<GooglePersonResource>;
+    nextPageToken?: string;
+    nextSyncToken?: string;
+    totalPeople?: number;
+};
+export declare function buildListURL(params: {
+    pageToken?: string;
+    syncToken?: string;
+    pageSize?: number;
+}): string;
+export declare function mapPersonToEntity(person: GooglePersonResource): EntityRecord;
+export declare function buildPersonFromParams(params: Record<string, unknown>): Partial<GooglePersonResource>;
+export type CreateContactParams = {
+    accessToken: string;
+    params: Record<string, unknown>;
+    fetch?: typeof globalThis.fetch;
+};
+export declare function createContact(options: CreateContactParams): Promise<EntityRecord>;
+export type UpdateContactParams = {
+    accessToken: string;
+    sourceID: string;
+    params: Record<string, unknown>;
+    fetch?: typeof globalThis.fetch;
+};
+export declare function updateContact(options: UpdateContactParams): Promise<EntityRecord>;

package/lib/api.js

@@ -0,0 +1 @@
+let e="names,emailAddresses,phoneNumbers,organizations,photos",o="https://people.googleapis.com/v1";async function a(e){try{let o=await e.json();return o.error?.message??`${e.status} ${e.statusText}`}catch{return`${e.status} ${e.statusText}`}}export function buildListURL(a){let t=new URL(`${o}/people/me/connections`);return t.searchParams.set("personFields",e),t.searchParams.set("pageSize",String(a.pageSize??100)),null!=a.syncToken&&t.searchParams.set("syncToken",a.syncToken),t.searchParams.set("requestSyncToken","true"),null!=a.pageToken&&t.searchParams.set("pageToken",a.pageToken),t.toString()}export function mapPersonToEntity(e){return{sourceService:"google-contacts",sourceID:e.resourceName,displayName:e.names?.[0]?.displayName??"",email:e.emailAddresses?.[0]?.value??void 0,phoneNumber:e.phoneNumbers?.[0]?.value??void 0,organization:e.organizations?.[0]?.name??void 0,jobTitle:e.organizations?.[0]?.title??void 0,photoURL:e.photos?.[0]?.url??void 0,sourceURL:`https://contacts.google.com/person/${e.resourceName.replace("people/","")}`}}export function buildPersonFromParams(e){let o={};return null!=e.displayName&&(o.names=[{givenName:e.displayName}]),null!=e.email&&(o.emailAddresses=[{value:e.email}]),null!=e.phoneNumber&&(o.phoneNumbers=[{value:e.phoneNumber}]),(null!=e.organization||null!=e.jobTitle)&&(o.organizations=[{...null!=e.organization?{name:e.organization}:{},...null!=e.jobTitle?{title:e.jobTitle}:{}}]),o}export async function createContact(t){let n=t.fetch??globalThis.fetch,r=buildPersonFromParams(t.params),s=await n(`${o}/people:createContact?personFields=${e}`,{method:"POST",headers:{Authorization:`Bearer ${t.accessToken}`,"Content-Type":"application/json"},body:JSON.stringify(r)});if(!s.ok){let e=await a(s);throw Error(`Google People API error: ${e}`)}return mapPersonToEntity(await s.json())}export async function updateContact(t){let n=t.fetch??globalThis.fetch,r=`${o}/${t.sourceID}?personFields=${e}`,s=await n(r,{headers:{Authorization:`Bearer ${t.accessToken}`}});if(!s.ok){let e=await a(s);throw Error(`Google People API error: ${e}`)}let i=await s.json(),l=buildPersonFromParams(t.params);l.etag=i.etag;let u=[];null!=l.names&&u.push("names"),null!=l.emailAddresses&&u.push("emailAddresses"),null!=l.phoneNumbers&&u.push("phoneNumbers"),null!=l.organizations&&u.push("organizations");let p=`${o}/${t.sourceID}:updateContact?updatePersonFields=${u.join(",")}&personFields=${e}`,c=await n(p,{method:"PATCH",headers:{Authorization:`Bearer ${t.accessToken}`,"Content-Type":"application/json"},body:JSON.stringify(l)});if(!c.ok){let e=await a(c);throw Error(`Google People API error: ${e}`)}return mapPersonToEntity(await c.json())}

package/lib/connector.d.ts

@@ -0,0 +1,5 @@
+import type { ConnectorDefinition } from '@kubun/connector';
+export type CreateGoogleContactsConnectorOptions = {
+    fetch?: typeof globalThis.fetch;
+};
+export declare function createGoogleContactsConnector(options?: CreateGoogleContactsConnectorOptions): ConnectorDefinition;

package/lib/connector.js

@@ -0,0 +1 @@
+import{createGoogleContactsActionHandler as e}from"./actions.js";import{googleContactsClusters as t}from"./model.js";import{createGoogleContactsProvider as o}from"./provider.js";export function createGoogleContactsConnector(r){return{name:"google-contacts",version:"1.0.0",clusters:t,syncStrategies:["on-demand"],auth:{provider:"google",scopes:["https://www.googleapis.com/auth/contacts.readonly"],writeScopes:["https://www.googleapis.com/auth/contacts"]},actions:[{name:"create",description:"Create a new Google Contact",entityModel:"GoogleContact",requiresCredential:!0,input:{type:"object",properties:{displayName:{type:"string"},email:{type:"string"},phoneNumber:{type:"string"},organization:{type:"string"},jobTitle:{type:"string"}},required:["displayName"]}},{name:"update",description:"Update an existing Google Contact",entityModel:"GoogleContact",requiresCredential:!0,input:{type:"object",properties:{sourceID:{type:"string"},displayName:{type:"string"},email:{type:"string"},phoneNumber:{type:"string"},organization:{type:"string"},jobTitle:{type:"string"}},required:["sourceID"]}}],actionHandler:t=>e({credential:t.credential,fetch:r?.fetch}),serverProvider:e=>o({credential:e.credential,fetch:r?.fetch})}}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export { createGoogleContactsActionHandler, type GoogleContactsActionHandlerConfig, } from './actions.js';
+export { buildListURL, buildPersonFromParams, type CreateContactParams, createContact, type GoogleConnectionsResponse, type GooglePersonResource, mapPersonToEntity, type UpdateContactParams, updateContact, } from './api.js';
+export { type CreateGoogleContactsConnectorOptions, createGoogleContactsConnector, } from './connector.js';
+export { googleContactDefinition, googleContactsClusters } from './model.js';
+export { createGoogleContactsProvider, type GoogleContactsProviderConfig } from './provider.js';

package/lib/index.js

@@ -0,0 +1 @@
+export{createGoogleContactsActionHandler}from"./actions.js";export{buildListURL,buildPersonFromParams,createContact,mapPersonToEntity,updateContact}from"./api.js";export{createGoogleContactsConnector}from"./connector.js";export{googleContactDefinition,googleContactsClusters}from"./model.js";export{createGoogleContactsProvider}from"./provider.js";

package/lib/model.d.ts

@@ -0,0 +1,61 @@
+export declare const googleContactDefinition: {
+    readonly name: "GoogleContact";
+    readonly behavior: "default";
+    readonly interfaces: [string, string];
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly displayName: {
+                readonly type: "string";
+            };
+            readonly sourceService: {
+                readonly $ref: "#/definitions/SourceService";
+            };
+            readonly sourceID: {
+                readonly $ref: "#/definitions/SourceID";
+            };
+            readonly lastSyncedAt: {
+                readonly $ref: "#/definitions/DateTime";
+            };
+            readonly sourceURL: {
+                readonly $ref: "#/definitions/SourceURL";
+            };
+            readonly email: {
+                readonly type: "string";
+            };
+            readonly phoneNumber: {
+                readonly type: "string";
+            };
+            readonly organization: {
+                readonly type: "string";
+            };
+            readonly jobTitle: {
+                readonly type: "string";
+            };
+            readonly photoURL: {
+                readonly $ref: "#/definitions/PhotoURL";
+            };
+        };
+        readonly required: ["sourceService", "sourceID", "lastSyncedAt"];
+        readonly additionalProperties: false;
+        readonly definitions: {
+            readonly SourceService: {
+                readonly type: "string";
+                readonly title: "SourceService";
+                readonly minLength: 1;
+                readonly maxLength: 50;
+            };
+            readonly SourceID: {
+                readonly type: "string";
+                readonly title: "SourceID";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+            };
+            readonly SourceURL: import("json-schema-typed").JSONSchema.String;
+            readonly PhotoURL: import("json-schema-typed").JSONSchema.String;
+            readonly DateTime: import("json-schema-typed").JSONSchema.String;
+        };
+    };
+    readonly fieldsMeta: {};
+};
+export declare const googleContactsClusters: import("@kubun/protocol").ClustersRecord;

package/lib/model.js

@@ -0,0 +1 @@
+import{connectorClusters as e,connectorModelIDs as t}from"@kubun/connector";import{modelIDs as o,modelsClusters as i}from"@kubun/models";import{GraphBuilder as r}from"@kubun/protocol";import{dateTimeSchema as n,urlSchema as s}from"@kubun/scalars";export const googleContactDefinition={name:"GoogleContact",behavior:"default",interfaces:[t.ExternalEntity,o.ContactKind],schema:{type:"object",properties:{displayName:{type:"string"},sourceService:{$ref:"#/definitions/SourceService"},sourceID:{$ref:"#/definitions/SourceID"},lastSyncedAt:{$ref:"#/definitions/DateTime"},sourceURL:{$ref:"#/definitions/SourceURL"},email:{type:"string"},phoneNumber:{type:"string"},organization:{type:"string"},jobTitle:{type:"string"},photoURL:{$ref:"#/definitions/PhotoURL"}},required:["sourceService","sourceID","lastSyncedAt"],additionalProperties:!1,definitions:{SourceService:{type:"string",title:"SourceService",minLength:1,maxLength:50},SourceID:{type:"string",title:"SourceID",minLength:1,maxLength:500},SourceURL:s,PhotoURL:s,DateTime:n}},fieldsMeta:{}};let c=new r({externalClusters:{...e,...i}});c.add(googleContactDefinition);export const googleContactsClusters=c.build();

package/lib/provider.d.ts

@@ -0,0 +1,6 @@
+import type { Credential, ServerDataProvider } from '@kubun/connector';
+export type GoogleContactsProviderConfig = {
+    credential: Credential;
+    fetch?: typeof globalThis.fetch;
+};
+export declare function createGoogleContactsProvider(config: GoogleContactsProviderConfig): ServerDataProvider;

package/lib/provider.js

@@ -0,0 +1 @@
+import{resolveModelID as e}from"@kubun/connector";import{buildListURL as n,mapPersonToEntity as o}from"./api.js";import{googleContactsClusters as t}from"./model.js";let l=e(t,"GoogleContact");export function createGoogleContactsProvider(e){let t=e.fetch??globalThis.fetch;async function a(o){let l=n({pageToken:o.pageToken,syncToken:o.syncToken}),a=await t(l,{headers:{Authorization:`Bearer ${e.credential.accessToken}`},signal:o.signal});if(!a.ok)throw Error(`Google People API error: ${a.status} ${a.statusText}`);return await a.json()}async function*i(e){let n,t;do{let i=await a({pageToken:n,signal:e.signal}),c=(i.connections??[]).map(o);n=i.nextPageToken,t=i.nextSyncToken,yield{modelID:l,entities:c,hasMore:null!=n,checkpoint:t}}while(null!=n)}return{supportedStrategies:["on-demand"],fetchAll:i,async *fetchChanges(e){let n,t=e.checkpoint;if(null==t)return void(yield*i(e));do{let i=await a({pageToken:n,syncToken:null!=n?void 0:t,signal:e.signal}),c=(i.connections??[]).map(o);n=i.nextPageToken,yield{modelID:l,entities:c,hasMore:null!=n,checkpoint:i.nextSyncToken}}while(null!=n)}}}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@kubun/connector-google-contacts",
+  "version": "0.8.0",
+  "license": "see LICENSE.md",
+  "keywords": [],
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@kubun/connector": "^0.8.0",
+    "@kubun/models": "^0.8.0",
+    "@kubun/provider-google": "^0.8.0",
+    "@kubun/protocol": "^0.8.0",
+    "@kubun/scalars": "^0.8.0"
+  },
+  "scripts": {
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "test:types": "tsc --noEmit -p tsconfig.test.json",
+    "test:unit": "vitest run",
+    "test": "pnpm run test:types && pnpm run test:unit"
+  }
+}