@cords/sdk 0.0.2 → 0.0.4

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CORDS Consortium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,106 @@
+type LocalizedFieldType = {
+    en: string;
+    fr: string;
+};
+type ResourceAddressType = {
+    street1: string;
+    street2: string;
+    city: string;
+    postalCode: string;
+    province: string;
+    country: string;
+    lat: number | null;
+    lng: number | null;
+};
+type ResourceBodyType = {
+    fees: string;
+    hours: string;
+    topics: string;
+    twitter: string | null;
+    youtube: string | null;
+    facebook: string | null;
+    linkedin: string | null;
+    instagram: string | null;
+    languages: string;
+    eligibility: string;
+    recordOwner: string;
+    accessibility: string;
+    documentsRequired: string;
+    applicationProcess: string;
+};
+type ResourceType = {
+    id: string;
+    name: LocalizedFieldType;
+    description: LocalizedFieldType;
+    website: LocalizedFieldType;
+    email: LocalizedFieldType;
+    address: ResourceAddressType;
+    addresses: ResourceAddressType[];
+    phoneNumbers: {
+        phone: string;
+        name: string;
+        type: string;
+    }[];
+    partner: string;
+    delivery: "national" | "provincial" | "local" | "regional" | null;
+    body: {
+        en: ResourceBodyType | null;
+        fr: ResourceBodyType | null;
+    };
+    result: {
+        id: string;
+        distance: number | null;
+        vectorDistance: number;
+    } | null;
+};
+type SearchResourceType = Omit<ResourceType, "website" | "email" | "phoneNumbers" | "addresses" | "address">;
+type SearchOptions = {
+    lat: number;
+    lng: number;
+    page?: number;
+    distance?: number;
+    pageSize?: number;
+    filter?: {
+        "211"?: boolean;
+        mentor?: boolean;
+        prosper?: boolean;
+        magnet?: boolean;
+    };
+};
+type CordsError = {
+    detail: string;
+    status: number;
+    title: string;
+    type: string;
+};
+
+declare const ResourceOptions: {};
+declare const CordsAPI: ({ apiKey, version, }: {
+    apiKey: string;
+    version?: "production" | "dev";
+}) => {
+    search: (q: string, options?: SearchOptions) => Promise<{
+        data: SearchResourceType[];
+        meta: {
+            total: number;
+            lat: number;
+            lng: number;
+        };
+    }>;
+    related: (id: string) => Promise<{
+        data: ResourceType[];
+    }>;
+    resource: (id: string) => Promise<ResourceType>;
+    resourceList: (ids: string[]) => Promise<{
+        data: ResourceType[];
+    }>;
+    nearestNeighbour: (id: string, options: {
+        lat: number;
+        lng: number;
+    }) => Promise<{
+        data: ResourceType[];
+    }>;
+};
+declare const formatServiceAddress: (address: ResourceAddressType) => string;
+
+export { CordsAPI, type CordsError, type ResourceAddressType, type ResourceBodyType, ResourceOptions, type ResourceType, type SearchOptions, type SearchResourceType, formatServiceAddress };

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+type LocalizedFieldType = {
+    en: string;
+    fr: string;
+};
+type ResourceAddressType = {
+    street1: string;
+    street2: string;
+    city: string;
+    postalCode: string;
+    province: string;
+    country: string;
+    lat: number | null;
+    lng: number | null;
+};
+type ResourceBodyType = {
+    fees: string;
+    hours: string;
+    topics: string;
+    twitter: string | null;
+    youtube: string | null;
+    facebook: string | null;
+    linkedin: string | null;
+    instagram: string | null;
+    languages: string;
+    eligibility: string;
+    recordOwner: string;
+    accessibility: string;
+    documentsRequired: string;
+    applicationProcess: string;
+};
+type ResourceType = {
+    id: string;
+    name: LocalizedFieldType;
+    description: LocalizedFieldType;
+    website: LocalizedFieldType;
+    email: LocalizedFieldType;
+    address: ResourceAddressType;
+    addresses: ResourceAddressType[];
+    phoneNumbers: {
+        phone: string;
+        name: string;
+        type: string;
+    }[];
+    partner: string;
+    delivery: "national" | "provincial" | "local" | "regional" | null;
+    body: {
+        en: ResourceBodyType | null;
+        fr: ResourceBodyType | null;
+    };
+    result: {
+        id: string;
+        distance: number | null;
+        vectorDistance: number;
+    } | null;
+};
+type SearchResourceType = Omit<ResourceType, "website" | "email" | "phoneNumbers" | "addresses" | "address">;
+type SearchOptions = {
+    lat: number;
+    lng: number;
+    page?: number;
+    distance?: number;
+    pageSize?: number;
+    filter?: {
+        "211"?: boolean;
+        mentor?: boolean;
+        prosper?: boolean;
+        magnet?: boolean;
+    };
+};
+type CordsError = {
+    detail: string;
+    status: number;
+    title: string;
+    type: string;
+};
+
+declare const ResourceOptions: {};
+declare const CordsAPI: ({ apiKey, version, }: {
+    apiKey: string;
+    version?: "production" | "dev";
+}) => {
+    search: (q: string, options?: SearchOptions) => Promise<{
+        data: SearchResourceType[];
+        meta: {
+            total: number;
+            lat: number;
+            lng: number;
+        };
+    }>;
+    related: (id: string) => Promise<{
+        data: ResourceType[];
+    }>;
+    resource: (id: string) => Promise<ResourceType>;
+    resourceList: (ids: string[]) => Promise<{
+        data: ResourceType[];
+    }>;
+    nearestNeighbour: (id: string, options: {
+        lat: number;
+        lng: number;
+    }) => Promise<{
+        data: ResourceType[];
+    }>;
+};
+declare const formatServiceAddress: (address: ResourceAddressType) => string;
+
+export { CordsAPI, type CordsError, type ResourceAddressType, type ResourceBodyType, ResourceOptions, type ResourceType, type SearchOptions, type SearchResourceType, formatServiceAddress };

package/dist/index.js

@@ -0,0 +1,183 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  CordsAPI: () => CordsAPI,
+  ResourceOptions: () => ResourceOptions,
+  formatServiceAddress: () => formatServiceAddress
+});
+module.exports = __toCommonJS(src_exports);
+var ResourceOptions = {};
+var CordsAPI = ({
+  apiKey,
+  version = "production"
+}) => {
+  const baseUrl = version === "production" ? "https://api.cords.ai" : "https://api.cords.dev";
+  const request = (input, init) => __async(void 0, null, function* () {
+    const res = yield fetch(input, __spreadProps(__spreadValues({}, init), {
+      headers: __spreadValues({
+        "x-api-key": apiKey
+      }, init == null ? void 0 : init.headers)
+    }));
+    if (!res.ok) {
+      if (res.status === 403)
+        throw new Error("Bad API key. Ensure you have a valid API key.");
+      const data = yield res.json();
+      if (data.detail)
+        throw new Error(data.detail);
+      else
+        throw new Error("An error occurred");
+    }
+    return res;
+  });
+  const search = (q, options) => __async(void 0, null, function* () {
+    const url = new URL("/search", baseUrl);
+    const params = new URLSearchParams({
+      q
+    });
+    if ((options == null ? void 0 : options.page) !== void 0)
+      params.append("page", options.page.toString());
+    if ((options == null ? void 0 : options.lat) !== void 0)
+      params.append("lat", options.lat.toString());
+    if ((options == null ? void 0 : options.lng) !== void 0)
+      params.append("lng", options.lng.toString());
+    if ((options == null ? void 0 : options.distance) !== void 0)
+      params.append("distance", options.distance.toString());
+    if ((options == null ? void 0 : options.filter) !== void 0) {
+      for (const [key, value] of Object.entries(options.filter)) {
+        if (value)
+          params.append(`filter[${key}]`, "true");
+      }
+    }
+    const res = yield request(`${url.toString()}?${params}`);
+    const data = yield res.json();
+    return data;
+  });
+  const related = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}/related`, baseUrl);
+    const res = yield request(url.toString());
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resource = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}`, baseUrl);
+    const res = yield request(url.toString());
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resourceList = (ids) => __async(void 0, null, function* () {
+    if (ids.length === 0)
+      return {
+        data: []
+      };
+    const params = new URLSearchParams();
+    ids.forEach((id, index) => params.append(`ids[${index}]`, id));
+    const url = new URL(`/search?${params.toString()}`, baseUrl);
+    const res = yield request(url.toString());
+    const data = yield res.json();
+    return data;
+  });
+  const nearestNeighbour = (id, options) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}/nearest-neighbor`, baseUrl);
+    const params = new URLSearchParams({
+      lat: options.lat.toString(),
+      lng: options.lng.toString()
+    });
+    const res = yield request(url.toString() + "?delivery=local&" + params.toString());
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    console.log(data);
+    return data;
+  });
+  return {
+    search,
+    related,
+    resource,
+    resourceList,
+    nearestNeighbour
+  };
+};
+var formatServiceAddress = (address) => {
+  const street1 = address.street1 ? address.street1 + ", " : "";
+  const street2 = address.street2 ? address.street2 + ", " : "";
+  const city = address.city ? address.city + ", " : "";
+  const province = address.province ? address.province + ", " : "";
+  const postalCode = address.postalCode ? address.postalCode : "";
+  const newAddress = street1 + street2 + city + province + postalCode;
+  if (newAddress.endsWith(", ")) {
+    return newAddress.slice(0, -2);
+  } else
+    return newAddress;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CordsAPI,
+  ResourceOptions,
+  formatServiceAddress
+});

package/dist/index.mjs

@@ -0,0 +1,159 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var ResourceOptions = {};
+var CordsAPI = ({
+  apiKey,
+  version = "production"
+}) => {
+  const baseUrl = version === "production" ? "https://api.cords.ai" : "https://api.cords.dev";
+  const request = (input, init) => __async(void 0, null, function* () {
+    const res = yield fetch(input, __spreadProps(__spreadValues({}, init), {
+      headers: __spreadValues({
+        "x-api-key": apiKey
+      }, init == null ? void 0 : init.headers)
+    }));
+    if (!res.ok) {
+      if (res.status === 403)
+        throw new Error("Bad API key. Ensure you have a valid API key.");
+      const data = yield res.json();
+      if (data.detail)
+        throw new Error(data.detail);
+      else
+        throw new Error("An error occurred");
+    }
+    return res;
+  });
+  const search = (q, options) => __async(void 0, null, function* () {
+    const url = new URL("/search", baseUrl);
+    const params = new URLSearchParams({
+      q
+    });
+    if ((options == null ? void 0 : options.page) !== void 0)
+      params.append("page", options.page.toString());
+    if ((options == null ? void 0 : options.lat) !== void 0)
+      params.append("lat", options.lat.toString());
+    if ((options == null ? void 0 : options.lng) !== void 0)
+      params.append("lng", options.lng.toString());
+    if ((options == null ? void 0 : options.distance) !== void 0)
+      params.append("distance", options.distance.toString());
+    if ((options == null ? void 0 : options.filter) !== void 0) {
+      for (const [key, value] of Object.entries(options.filter)) {
+        if (value)
+          params.append(`filter[${key}]`, "true");
+      }
+    }
+    const res = yield request(`${url.toString()}?${params}`);
+    const data = yield res.json();
+    return data;
+  });
+  const related = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}/related`, baseUrl);
+    const res = yield request(url.toString());
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resource = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}`, baseUrl);
+    const res = yield request(url.toString());
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resourceList = (ids) => __async(void 0, null, function* () {
+    if (ids.length === 0)
+      return {
+        data: []
+      };
+    const params = new URLSearchParams();
+    ids.forEach((id, index) => params.append(`ids[${index}]`, id));
+    const url = new URL(`/search?${params.toString()}`, baseUrl);
+    const res = yield request(url.toString());
+    const data = yield res.json();
+    return data;
+  });
+  const nearestNeighbour = (id, options) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}/nearest-neighbor`, baseUrl);
+    const params = new URLSearchParams({
+      lat: options.lat.toString(),
+      lng: options.lng.toString()
+    });
+    const res = yield request(url.toString() + "?delivery=local&" + params.toString());
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    console.log(data);
+    return data;
+  });
+  return {
+    search,
+    related,
+    resource,
+    resourceList,
+    nearestNeighbour
+  };
+};
+var formatServiceAddress = (address) => {
+  const street1 = address.street1 ? address.street1 + ", " : "";
+  const street2 = address.street2 ? address.street2 + ", " : "";
+  const city = address.city ? address.city + ", " : "";
+  const province = address.province ? address.province + ", " : "";
+  const postalCode = address.postalCode ? address.postalCode : "";
+  const newAddress = street1 + street2 + city + province + postalCode;
+  if (newAddress.endsWith(", ")) {
+    return newAddress.slice(0, -2);
+  } else
+    return newAddress;
+};
+export {
+  CordsAPI,
+  ResourceOptions,
+  formatServiceAddress
+};

package/package.json

@@ -3,7 +3,7 @@
 	"main": "./dist/index.js",
 	"module": "./dist/index.mjs",
 	"types": "./dist/index.d.ts",
-	"version": "0.0.2",
+	"version": "0.0.4",
 	"private": false,
 	"publishConfig": {
 		"access": "public"
@@ -20,5 +20,6 @@
 	},
 	"dependencies": {
 		"tsup": "^8.0.2"
-	}
+	},
+	"license": "MIT"
 }

package/src/index.ts

@@ -1,11 +1,14 @@
-import { SearchResourceType } from "../dist";
-import type { CordsError, ResourceAddressType, ResourceType, SearchOptions } from "./types";
+import type {
+	CordsError,
+	ResourceAddressType,
+	ResourceType,
+	SearchOptions,
+	SearchResourceType,
+} from "./types";
 export * from "./types";
 
 export const ResourceOptions = {};
 
-const baseUrl = "https://api.cords.ai";
-
 export const CordsAPI = ({
 	apiKey,
 	version = "production",
@@ -119,6 +122,7 @@ export const CordsAPI = ({
 			throw new Error(data.detail);
 		}
 		const data = await res.json();
+		console.log(data);
 		return data as { data: ResourceType[] };
 	};
 

package/src/types.ts

@@ -50,6 +50,11 @@ export type ResourceType = {
 		en: ResourceBodyType | null;
 		fr: ResourceBodyType | null;
 	};
+	result: {
+		id: string;
+		distance: number | null;
+		vectorDistance: number;
+	} | null;
 };
 
 export type SearchResourceType = Omit<