{"id":28273099,"url":"https://github.com/zesty-io/bdx-connector-integration","last_synced_at":"2026-05-01T06:33:48.440Z","repository":{"id":42327668,"uuid":"180684402","full_name":"zesty-io/bdx-connector-integration","owner":"zesty-io","description":"Zesty.io BDX Integration - Cloud Function to FTP to Zesty.io","archived":false,"fork":false,"pushed_at":"2023-01-04T08:16:58.000Z","size":616,"stargazers_count":1,"open_issues_count":10,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-06-17T23:39:15.838Z","etag":null,"topics":["cloud-function","customer","ftp","nodejs","xml"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zesty-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-11T00:31:12.000Z","updated_at":"2023-06-23T10:25:42.000Z","dependencies_parsed_at":"2023-02-02T04:46:47.686Z","dependency_job_id":null,"html_url":"https://github.com/zesty-io/bdx-connector-integration","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zesty-io/bdx-connector-integration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zesty-io%2Fbdx-connector-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zesty-io%2Fbdx-connector-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zesty-io%2Fbdx-connector-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zesty-io%2Fbdx-connector-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zesty-io","download_url":"https://codeload.github.com/zesty-io/bdx-connector-integration/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zesty-io%2Fbdx-connector-integration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32487534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-function","customer","ftp","nodejs","xml"],"created_at":"2025-05-21T00:17:21.854Z","updated_at":"2026-05-01T06:33:48.435Z","avatar_url":"https://github.com/zesty-io.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BDX Integration to Zesty.io API CMS\n\nMakes an FTP connection to a customers BDX ftp account, pulls the XML files, and imports them into a specific content model.\n\nThis Zesty.io integration writes a file to the ftp named `zesty-sync.txt` with a timestamp of the sync. The system will sync once a day.\n\n### Process\n\n* This endpoint needs to be periodically hit on a daily basis to get new information\n* data needs to be verified to prevent dual entry\n* an notification needs to be written to tell a user when the last sync was\n\n## Key Word Topics\n\nGoogle Cloud Function, Digital Transformation, Legacy Lift and Shift, ERP to Cloud, Google Task, FTP, XML\n\n## Project Organization\n\n`/models/` contains files that describe the content model in zesty, which values map the location of the BDX data in the XML. A function exists to iterate though this special object to verify data existing in the xml files. Model must only associate themselves with \n\n`/lib/` has functions to iterate through the special object, make ftp connection etc.\n\n`index.js` the core of the cloud function\n\n\n## The BDX XML file\n\nThe BDX file is a large XML file that contains a lot of data in a child parent format.\n\n... = has one or many children\n\n* Builders (one of many children)\n    * Corporations... (owning organiztion)\n        * Builder... (represents the contractor), contains info on the builder contact info etc.\n            * Subdivision... (a project developement) container info like area, name etc.\n                * Plan... (an architectual plan with information on the home, images, and other data)\n                    * Plan Images... (images associated with the Plan)\n                    * Spec... (home listings) info on price, movein, and unit info associated with the plan etc.\n                        * Spec Images... (images associate with the spec)\n\n\n\n## Function Flow Breakdown\n\n* function is posted to with the instance zuid\n* function looks for secret credentials associated with instance, makes zesty authentication and get token\n* makes connection to zesty api\n* bdx details are pull from the instance settings\n* FTP connecton is made with BDX credentials from zesty settings\n* BDX XML file id downloaded to a temporary folder\n* BDX file is read and converted into a Javascript Object\n* bdx javascript object is parsed to prepare into post bodies and write to the zesty api, this is the order\n    * Builders\n        * Corporations\n            * Community Images\n            * Plans\n                * Plan Images\n                * Specs\n                    * Spec Images\n* post bodies are iterated through to create content\n    * Item is check if it is unique by looking it up by URL, if exists skip\n    * Item is entered into the system\n    * Item is published\n* Process completes, sync file is written to the ftp\n\n\n\n**Endpoints**\n\n- zesty-dev: https://us-central1-zesty-dev.cloudfunctions.net/bdxIntegration\n- zesty-stage: https://us-central1-zesty-stage.cloudfunctions.net/bdxIntegration\n- zesty-prod: https://us-central1-zesty-prod.cloudfunctions.net/bdxIntegration\n\n# local deployment\n\ninstall functions (google's test package)\n\n`npm install`\n\nNPM deploy scripts\n\n`npm run deploy:local`\n`npm run deploy:dev`\n`npm run deploy:stage`\n`npm run deploy:prod`\n\n\n\n### Testing Remote Project\n\nProvide a Project ID as shown below before starting the Emulator:\n\n```\nfunctions config set projectId zesty-dev\n```\n\nBefore you can deploy a function, you need to start the Emulator as follows:\n\n```\nfunctions start\n```\n\nYou stop the Emulator by calling stop:\n\n```\nfunctions stop\n```\n\nDeploy an HTTP function to the Emulator as follows:\n\n```\nfunctions deploy bdxIntegration --env-vars-file .env.yaml --trigger-http --timeout=240s\n```\n\nRead the last 50 lines of the log from the Emulator:\n\n```\nfunctions logs read --limit=50\n```\n\n\n## NPM Deployment Commands\n\nNote: for local developer you need to paste in values, remove before commits.\n\n- Local: `npm run deploy:dev`\n- Dev: `npm run deploy:dev`\n- Stage: `npm run deploy:stage`\n- Prod: `npm run deploy:prod`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzesty-io%2Fbdx-connector-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzesty-io%2Fbdx-connector-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzesty-io%2Fbdx-connector-integration/lists"}