@withgateway/sdk 0.1.20 → 0.2.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.
Files changed (130) hide show
  1. package/README.md +141 -2
  2. package/dist/cli.js +8683 -1343
  3. package/dist/cli.js.map +1 -1
  4. package/dist/cli.mjs +8683 -1344
  5. package/dist/cli.mjs.map +1 -1
  6. package/dist/index.d.mts +1 -1
  7. package/dist/index.d.ts +1 -1
  8. package/dist/index.js +979 -46
  9. package/dist/index.js.map +1 -1
  10. package/dist/index.mjs +943 -38
  11. package/dist/index.mjs.map +1 -1
  12. package/dist/tracing/index.js +9 -2
  13. package/dist/tracing/index.js.map +1 -1
  14. package/dist/tracing/index.mjs +9 -2
  15. package/dist/tracing/index.mjs.map +1 -1
  16. package/dist/worlds/index.d.mts +738 -28
  17. package/dist/worlds/index.d.ts +738 -28
  18. package/dist/worlds/index.js +940 -42
  19. package/dist/worlds/index.js.map +1 -1
  20. package/dist/worlds/index.mjs +934 -36
  21. package/dist/worlds/index.mjs.map +1 -1
  22. package/package.json +9 -2
  23. package/runtime/gatewaysdk/__init__.py +0 -0
  24. package/runtime/gatewaysdk/environment/__init__.py +108 -0
  25. package/runtime/gatewaysdk/environment/_bundle.py +281 -0
  26. package/runtime/gatewaysdk/environment/_harbor.py +276 -0
  27. package/runtime/gatewaysdk/environment/_materialize.py +97 -0
  28. package/runtime/gatewaysdk/environment/_tar.py +33 -0
  29. package/runtime/gatewaysdk/environment/_world.py +346 -0
  30. package/runtime/gatewaysdk/environment/core.py +527 -0
  31. package/runtime/gatewaysdk/environment/errors.py +58 -0
  32. package/runtime/gatewaysdk/environment/runtime.py +150 -0
  33. package/runtime/gatewaysdk/environment/schema/__init__.py +35 -0
  34. package/runtime/gatewaysdk/environment/schema/__main__.py +225 -0
  35. package/runtime/gatewaysdk/environment/schema/_slack_fidelity.py +116 -0
  36. package/runtime/gatewaysdk/environment/schema/_slack_scenario.py +183 -0
  37. package/runtime/gatewaysdk/environment/schema/api.py +1628 -0
  38. package/runtime/gatewaysdk/environment/schema/batch.py +755 -0
  39. package/runtime/gatewaysdk/environment/schema/compiler.py +615 -0
  40. package/runtime/gatewaysdk/environment/schema/conform.py +428 -0
  41. package/runtime/gatewaysdk/environment/schema/connector.py +777 -0
  42. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/handlers.py +17 -0
  43. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/parity.json +28 -0
  44. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/provenance.json +233 -0
  45. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/scope.toml +112 -0
  46. package/runtime/gatewaysdk/environment/schema/connectors/apple-business-manager/world.json +1380 -0
  47. package/runtime/gatewaysdk/environment/schema/connectors/base.json +28 -0
  48. package/runtime/gatewaysdk/environment/schema/connectors/custom/handlers.py +18 -0
  49. package/runtime/gatewaysdk/environment/schema/connectors/custom/world.json +123 -0
  50. package/runtime/gatewaysdk/environment/schema/connectors/github/handlers.py +81 -0
  51. package/runtime/gatewaysdk/environment/schema/connectors/github/parity.json +37 -0
  52. package/runtime/gatewaysdk/environment/schema/connectors/github/provenance.json +134 -0
  53. package/runtime/gatewaysdk/environment/schema/connectors/github/scope.toml +158 -0
  54. package/runtime/gatewaysdk/environment/schema/connectors/github/world.json +5869 -0
  55. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/handlers.py +23 -0
  56. package/runtime/gatewaysdk/environment/schema/connectors/google-calendar/world.json +209 -0
  57. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/handlers.py +18 -0
  58. package/runtime/gatewaysdk/environment/schema/connectors/google-drive/world.json +286 -0
  59. package/runtime/gatewaysdk/environment/schema/connectors/jamf/handlers.py +34 -0
  60. package/runtime/gatewaysdk/environment/schema/connectors/jamf/parity.json +49 -0
  61. package/runtime/gatewaysdk/environment/schema/connectors/jamf/provenance.json +181 -0
  62. package/runtime/gatewaysdk/environment/schema/connectors/jamf/scope.toml +128 -0
  63. package/runtime/gatewaysdk/environment/schema/connectors/jamf/world.json +2218 -0
  64. package/runtime/gatewaysdk/environment/schema/connectors/jira/handlers.py +28 -0
  65. package/runtime/gatewaysdk/environment/schema/connectors/jira/world.json +389 -0
  66. package/runtime/gatewaysdk/environment/schema/connectors/kandji/handlers.py +38 -0
  67. package/runtime/gatewaysdk/environment/schema/connectors/kandji/parity.json +29 -0
  68. package/runtime/gatewaysdk/environment/schema/connectors/kandji/provenance.json +152 -0
  69. package/runtime/gatewaysdk/environment/schema/connectors/kandji/scope.toml +120 -0
  70. package/runtime/gatewaysdk/environment/schema/connectors/kandji/world.json +765 -0
  71. package/runtime/gatewaysdk/environment/schema/connectors/linear/handlers.py +20 -0
  72. package/runtime/gatewaysdk/environment/schema/connectors/linear/world.json +363 -0
  73. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/fidelity.json +45 -0
  74. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/handlers.py +1 -0
  75. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/provenance.json +851 -0
  76. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/scope.md +231 -0
  77. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/teams-types.json +1710 -0
  78. package/runtime/gatewaysdk/environment/schema/connectors/microsoft-teams/world.json +858 -0
  79. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/handlers.py +32 -0
  80. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/parity.json +50 -0
  81. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/provenance.json +137 -0
  82. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/scope.toml +78 -0
  83. package/runtime/gatewaysdk/environment/schema/connectors/netsuite/world.json +16243 -0
  84. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/handlers.py +806 -0
  85. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/parity.json +46 -0
  86. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/provenance.json +143 -0
  87. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/scope.toml +174 -0
  88. package/runtime/gatewaysdk/environment/schema/connectors/salesforce/world.json +4695 -0
  89. package/runtime/gatewaysdk/environment/schema/connectors/slack/MODEL.md +236 -0
  90. package/runtime/gatewaysdk/environment/schema/connectors/slack/capabilities.json +1039 -0
  91. package/runtime/gatewaysdk/environment/schema/connectors/slack/handlers.py +762 -0
  92. package/runtime/gatewaysdk/environment/schema/connectors/slack/parity.json +65 -0
  93. package/runtime/gatewaysdk/environment/schema/connectors/slack/provenance.json +294 -0
  94. package/runtime/gatewaysdk/environment/schema/connectors/slack/scope.toml +44 -0
  95. package/runtime/gatewaysdk/environment/schema/connectors/slack/world.json +4993 -0
  96. package/runtime/gatewaysdk/environment/schema/connectors/workday/handlers.py +75 -0
  97. package/runtime/gatewaysdk/environment/schema/connectors/workday/parity.json +36 -0
  98. package/runtime/gatewaysdk/environment/schema/connectors/workday/provenance.json +179 -0
  99. package/runtime/gatewaysdk/environment/schema/connectors/workday/scope.toml +180 -0
  100. package/runtime/gatewaysdk/environment/schema/connectors/workday/world.json +806 -0
  101. package/runtime/gatewaysdk/environment/schema/data.py +593 -0
  102. package/runtime/gatewaysdk/environment/schema/extract.py +263 -0
  103. package/runtime/gatewaysdk/environment/schema/host.py +2407 -0
  104. package/runtime/gatewaysdk/environment/schema/host_surfaces.py +275 -0
  105. package/runtime/gatewaysdk/environment/schema/platform.py +1272 -0
  106. package/runtime/gatewaysdk/environment/schema/scaffold.py +250 -0
  107. package/runtime/gatewaysdk/environment/schema/skill.py +118 -0
  108. package/runtime/gatewaysdk/environment/schema/skills/agents/connector-template-author.md +202 -0
  109. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONNECTORS.md +331 -0
  110. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/CONVENTIONS.md +100 -0
  111. package/runtime/gatewaysdk/environment/schema/skills/connector-schema-authoring/SKILL.md +313 -0
  112. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/ROWS.md +223 -0
  113. package/runtime/gatewaysdk/environment/schema/skills/world-data-ingestion/SKILL.md +293 -0
  114. package/runtime/gatewaysdk/environment/schema/skills/worlds-getting-started/SKILL.md +390 -0
  115. package/runtime/gatewaysdk/environment/schema/slack.py +757 -0
  116. package/runtime/gatewaysdk/environment/schema/snapshot.py +479 -0
  117. package/runtime/gatewaysdk/environment/schema/store.py +904 -0
  118. package/runtime/gatewaysdk/environment/schema/tasks.py +525 -0
  119. package/runtime/gatewaysdk/environment/schema/tools_world.py +322 -0
  120. package/runtime/gatewaysdk/environment/schema/validation.py +577 -0
  121. package/runtime/gatewaysdk/environment/schema/worker.py +78 -0
  122. package/runtime/gatewaysdk/environment/schema/workers.py +500 -0
  123. package/runtime/gatewaysdk/environment/schema/world_tests.py +336 -0
  124. package/skills/agents/connector-template-author.md +202 -0
  125. package/skills/connector-schema-authoring/CONNECTORS.md +331 -0
  126. package/skills/connector-schema-authoring/CONVENTIONS.md +100 -0
  127. package/skills/connector-schema-authoring/SKILL.md +313 -0
  128. package/skills/world-data-ingestion/ROWS.md +223 -0
  129. package/skills/world-data-ingestion/SKILL.md +293 -0
  130. package/skills/worlds-getting-started/SKILL.md +390 -0
@@ -0,0 +1,46 @@
1
+ {
2
+ "version": 1,
3
+ "connector": "salesforce",
4
+ "status": "subset",
5
+ "world_tools": [
6
+ "create_opportunity",
7
+ "list_opportunities",
8
+ "query_records",
9
+ "update_stage"
10
+ ],
11
+ "registration": {
12
+ "mode": "managed",
13
+ "provider": "merge",
14
+ "managed_tool_allowlist": ["create_opportunity", "list_opportunities"]
15
+ },
16
+ "surfaces": [
17
+ {
18
+ "name": "Salesforce hosted MCP",
19
+ "kind": "official_hosted_mcp",
20
+ "auth": "Salesforce OAuth and org permissions",
21
+ "manifest_validation": "credential_required",
22
+ "supported_world_tools": [
23
+ "create_opportunity",
24
+ "list_opportunities",
25
+ "query_records",
26
+ "update_stage"
27
+ ],
28
+ "limitations": [
29
+ "The manifest is org-specific and was not retrieved.",
30
+ "Custom SObjects, fields, permissions, and requiredness require describe-on-bind."
31
+ ],
32
+ "evidence": ["https://developer.salesforce.com/docs/platform/mcp/overview"]
33
+ },
34
+ {
35
+ "name": "Merge Agent Handler",
36
+ "kind": "managed_provider",
37
+ "auth": "Merge managed connection",
38
+ "manifest_validation": "public_catalog",
39
+ "supported_world_tools": ["create_opportunity", "list_opportunities"],
40
+ "limitations": [
41
+ "query_records and update_stage are semantic, not exact provider-name matches."
42
+ ],
43
+ "evidence": ["https://docs.merge.dev/agent-handler/overview/"]
44
+ }
45
+ ]
46
+ }
@@ -0,0 +1,143 @@
1
+ {
2
+ "slug": "salesforce",
3
+ "shape": "tenant-shaped",
4
+ "label": "subset",
5
+ "prefix": "sf_",
6
+ "domain_version": "3.0.1",
7
+ "package_version": "3.0.0",
8
+ "generated_at": "2026-09-06T22:27:40Z",
9
+ "authored_by": "connector-template-author; deterministic transcription of pinned Salesforce Object Reference field tables",
10
+ "importer": null,
11
+ "scope": "scope.toml",
12
+ "scope_hash": "sha256:490454bcd78ebfa2368bbf31469913733d620d29862bba0342b6613a261112bd",
13
+ "world_hash_before_compile": "sha256:029a7006c09cbf7038a3926e9b374c04e83928abb8da9592cb9aed2985dd7852",
14
+ "coverage": {
15
+ "entities": 7,
16
+ "top_level_fields": 600,
17
+ "recursive_fields": 656,
18
+ "recursive_counting": "For each entity schema, count every object property, resolve local $ref, and descend properties, array items, allOf, anyOf and oneOf. External base primitive refs contribute no nested properties.",
19
+ "by_entity": {
20
+ "sf_users": {"top_level": 176, "recursive": 184},
21
+ "sf_accounts": {"top_level": 118, "recursive": 142},
22
+ "sf_contacts": {"top_level": 85, "recursive": 101},
23
+ "sf_leads": {"top_level": 75, "recursive": 83},
24
+ "sf_opportunities": {"top_level": 55, "recursive": 55},
25
+ "sf_cases": {"top_level": 51, "recursive": 51},
26
+ "sf_tasks": {"top_level": 40, "recursive": 40}
27
+ },
28
+ "reconstruction_target_reconciliation": "The supplied prior measurement was 641. Re-transcribing the pinned pages produces 656 without inventing fields: 641 documented table rows plus recursively expanded compound members, then +7 required Id keys omitted from the object-specific tables and +8 actual API properties obtained by splitting four Account rows that each declare multiple field names. Dropping those 15 evidenced/key fields solely to match 641 would be a fidelity bug."
29
+ },
30
+ "describe_on_bind": {
31
+ "required": true,
32
+ "endpoint": "GET /services/data/v{version}/sobjects/{sObject}/describe",
33
+ "statement": "An unbound Salesforce world is a standard-object skeleton, not the org model. Before fidelity grading, bind-time describe must supply the org's enabled fields, custom objects and fields, referenceTo sets, record types, create/update flags, nillability, and picklist entries.",
34
+ "overlay_is_additive_only": true,
35
+ "sandbox": "Developer Edition org or scratch org via Dev Hub. None was available for this authoring run."
36
+ },
37
+ "primary_vendor_evidence": {
38
+ "preference": "Salesforce per-org sObject describe or generated OAS3 is preferred machine-readable evidence, but both require an authenticated org. With no sandbox credentials, this bundle uses the vendor's structured Object Reference field tables and closes enums only over explicit vendor value blocks.",
39
+ "machine_readable_not_captured": [
40
+ "GET /services/data/v68.0/sobjects/{name}/describe",
41
+ "GET /services/data/v68.0/async/specifications/oas3"
42
+ ],
43
+ "byte_verification": {
44
+ "performed_at": "2026-09-06T21:28:18Z",
45
+ "result": "All nine pinned URLs were fetched and their SHA-256 digests matched the values below.",
46
+ "command_summary": "Python urllib.request fetched each URL in memory; hashlib.sha256 was compared with the pinned digest. No evidence bytes were committed."
47
+ }
48
+ },
49
+ "source": [
50
+ {
51
+ "kind": "docs",
52
+ "role": "REST error response shape and HTTP status codes",
53
+ "title": "REST API Developer Guide - Status Codes and Error Responses",
54
+ "url": "https://developer.salesforce.com/docs/get_document_content/api_rest/errorcodes.htm/en-us/264.0",
55
+ "page_url": "https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/errorcodes.htm",
56
+ "version": "Winter '27, API 68.0, doc 264.0",
57
+ "sha256": "4f94b1c082c5c6e238e0b8266706120f86a1fa20c800fdc568145d3513489038",
58
+ "bytes": 11773
59
+ },
60
+ {
61
+ "kind": "docs",
62
+ "role": "StatusCode enumeration",
63
+ "title": "SOAP API Developer Guide - Core Data Types Used in API Calls",
64
+ "url": "https://developer.salesforce.com/docs/get_document_content/api/sforce_api_calls_concepts_core_data_objects.htm/en-us/264.0",
65
+ "page_url": "https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm",
66
+ "version": "Winter '27, API 68.0, doc 264.0",
67
+ "sha256": "1940a48938014c3abb0e205e865eaacb3e54bec5da072fbe85e94938ec747f85",
68
+ "bytes": 189354
69
+ },
70
+ {
71
+ "kind": "structured_vendor_docs",
72
+ "role": "field names, declared types, capabilities, nillability, reference targets, descriptions, and explicit value blocks",
73
+ "title": "Object Reference for the Salesforce Platform",
74
+ "version": "Winter '27, API 68.0, doc 264.0",
75
+ "base_url": "https://developer.salesforce.com/docs/get_document_content/object_reference/{page}/en-us/264.0",
76
+ "pages": [
77
+ {"sobject": "User", "page": "sforce_api_objects_user.htm", "sha256": "64825cc38d4003e2e71dc4a103aa32754bfd2f17364642a7fe921f9e68f11e22", "bytes": 268422},
78
+ {"sobject": "Account", "page": "sforce_api_objects_account.htm", "sha256": "9b81b8f2551ba51be784c7c2133e8115bc62bb8a9b8d7169ada29ed96afe5bb5", "bytes": 106681},
79
+ {"sobject": "Contact", "page": "sforce_api_objects_contact.htm", "sha256": "4fb7ba6e0b0b9a3517d0c86e970138a024150781910e0c8e6bf221d40f66ecf4", "bytes": 116404},
80
+ {"sobject": "Lead", "page": "sforce_api_objects_lead.htm", "sha256": "4fb2038711e4a7378d1e4aa63bb5b979f48f8f0a07e1fd1d1d980eecbe05c55e", "bytes": 150981},
81
+ {"sobject": "Opportunity", "page": "sforce_api_objects_opportunity.htm", "sha256": "e44a2029af4619d39b66db4bbcdbe31867099cb0e39eaca7621d2e57fbac99ab", "bytes": 93075},
82
+ {"sobject": "Case", "page": "sforce_api_objects_case.htm", "sha256": "f0d806d88dd4200ed281288e98f48d7f7a445f42176c701d29bc6f86cc2876fd", "bytes": 70629},
83
+ {"sobject": "Task", "page": "sforce_api_objects_task.htm", "sha256": "733b15b57a991f546b0413f32be65116deed7bac715c4639715725150d8a959e", "bytes": 81499}
84
+ ]
85
+ }
86
+ ],
87
+ "transcription_rules": {
88
+ "field_names": "Vendor casing is unchanged. Account rows that list multiple API names are split into those names rather than represented as invented grouped properties.",
89
+ "types": {
90
+ "id/reference": "base Id; nillable references use a direct nullable string definition so relationships compile",
91
+ "string/textarea/url/phone/combobox/picklist/multipicklist": "string, nullable exactly when the Properties block declares Nillable",
92
+ "boolean": "boolean",
93
+ "int": "integer",
94
+ "currency/double": "number",
95
+ "percent": "number from 0 through 100",
96
+ "date": "format date with exact length 10",
97
+ "dateTime/datetime": "base Timestamp",
98
+ "JunctionIdList": "array of ids",
99
+ "address": "nullable nested object with city, country, geocodeAccuracy, latitude, longitude, postalCode, state and street"
100
+ },
101
+ "requiredness": "Entity properties are the union of read/create declarations; the intersection used by stored projection records is Id. OpportunityCreate separately requires vendor create-contract fields Name, StageName and CloseDate, plus the documented simulation-only Id deviation.",
102
+ "enums": "Only explicit value lists/tables are enums. Administrator and org value sets remain strings even where the docs give examples or defaults.",
103
+ "relationships": "A reference becomes a restrict relationship only when Refers To declares exactly one of the seven modelled objects. Polymorphic and out-of-scope targets remain ids."
104
+ },
105
+ "declared_value_blocks_used": [
106
+ "User.DefaultGroupNotificationFrequency", "User.DigestFrequency",
107
+ "Account.CleanStatus", "Account.PersonActionCadenceState", "Account.PersonPronouns",
108
+ "Contact.ActionCadenceState", "Contact.ContactSource", "Contact.DepartmentGroup", "Contact.Pronouns", "Contact.TitleType",
109
+ "Lead.ActionCadenceState", "Lead.CleanStatus", "Lead.Pronouns",
110
+ "Opportunity.ForecastCategory", "Opportunity.ForecastCategoryName",
111
+ "Task.CallType", "Task.RecurrenceInstance", "Task.RecurrenceType", "Task.Status", "Task.TaskSubtype"
112
+ ],
113
+ "fidelity_corrections": [
114
+ "Expanded all seven object pages instead of the brief-only 46-field skeleton.",
115
+ "Preserved all seven compound address fields as nested vendor objects rather than flattening them.",
116
+ "Removed unsupported default-org enums for StageName, Lead.Status and Case Status/Priority/Origin; these are org-controlled strings until describe-on-bind.",
117
+ "Retained the vendor-declared sf_users Username uniqueness as a sparse optional unique constraint, so SOQL projections may omit it.",
118
+ "Made entity requiredness projection-compatible (Id only) and moved Opportunity create requiredness to OpportunityCreate.",
119
+ "Made OwnerId optional in OpportunityCreate because Salesforce defaults it on create.",
120
+ "Added every evidenced single-target relationship among the seven entities and retained polymorphic references without false foreign keys.",
121
+ "Broadened query_records field validation to all 600 top-level fields and made sparse row access null-safe.",
122
+ "Corrected Opportunity IsClosed and IsWon to the vendor-declared boolean type; seeded tool execution exposed the prior string transcription."
123
+ ],
124
+ "errors": {
125
+ "format": "[{\"message\": string, \"errorCode\": string, \"fields\": [string]}]",
126
+ "codes_modelled": ["REQUIRED_FIELD_MISSING", "FIELD_CUSTOM_VALIDATION_EXCEPTION", "INVALID_FIELD", "NOT_FOUND", "ENTITY_IS_DELETED", "INVALID_CROSS_REFERENCE_KEY", "INVALID_TYPE", "MALFORMED_QUERY"]
127
+ },
128
+ "unverified": [
129
+ "No authenticated sObject describe or generated OAS3 document was available; every tenant-dependent claim awaits describe-on-bind.",
130
+ "No sandbox round trip, relationship insertion matrix, golden replay, or CDC fixture verification ran. These checks are skipped, not passed.",
131
+ "Fields omitted from the object-specific pages' common-field block are excluded except Id and page-declared IsDeleted.",
132
+ "Salesforce 15-or-18-character id shape is under-constrained by base Id because relationship key resolution rejects the composition needed to express the disjunction.",
133
+ "create_opportunity still uses the default labels Closed Won and Closed Lost to derive IsClosed/IsWon; a tenant overlay/handler generation step must derive these flags from that org's OpportunityStage metadata.",
134
+ "The query tool implements only its documented SELECT/WHERE/ORDER/LIMIT subset, not complete SOQL semantics.",
135
+ "No synthetic customer or vendor records were added; template layout does not support connector-local data fixtures."
136
+ ],
137
+ "subset_reasons": [
138
+ "Tenant describe is unavailable and mandatory.",
139
+ "No Developer Edition or scratch-org round trip or goldens exist.",
140
+ "Common audit fields, out-of-scope target entities, CDC entities, org custom schema and org picklist values are excluded.",
141
+ "Compiler limitations prevent polymorphic relationships, conditional availability and exact Salesforce id length."
142
+ ]
143
+ }
@@ -0,0 +1,174 @@
1
+ # Scope of the Salesforce tenant-shaped standard-object skeleton.
2
+ # The shared bundle is not an org model. A bound world's describe response is
3
+ # authoritative for enabled features, custom schema, record types and picklists.
4
+
5
+ slug = "salesforce"
6
+ shape = "tenant-shaped"
7
+ prefix = "sf_"
8
+ source_kind = "docs"
9
+ importer = "none (deterministic transcription of pinned vendor field tables)"
10
+
11
+ [coverage]
12
+ entity_count = 7
13
+ top_level_field_count = 600
14
+ recursive_field_count = 656
15
+ address_occurrences = 7
16
+ address_fields_per_occurrence = 8
17
+ status = "subset"
18
+ reason = "The seven pinned standard-object pages are broad, but Salesforce is tenant-shaped and no Developer Edition or scratch org was available for describe or round-trip verification."
19
+
20
+ [entities.User]
21
+ entity = "sf_users"
22
+ field_count = 176
23
+ recursive_field_count = 184
24
+ fields_from = "All 175 User table declarations plus the common Id key omitted from the object-specific table."
25
+
26
+ [entities.Account]
27
+ entity = "sf_accounts"
28
+ field_count = 118
29
+ recursive_field_count = 142
30
+ fields_from = "All Account and person-account table declarations plus Id. Four multi-name rows are expanded to their 12 actual API field names."
31
+
32
+ [entities.Contact]
33
+ entity = "sf_contacts"
34
+ field_count = 85
35
+ recursive_field_count = 101
36
+ fields_from = "All 84 Contact table declarations plus Id."
37
+
38
+ [entities.Lead]
39
+ entity = "sf_leads"
40
+ field_count = 75
41
+ recursive_field_count = 83
42
+ fields_from = "All 74 Lead table declarations plus Id."
43
+
44
+ [entities.Opportunity]
45
+ entity = "sf_opportunities"
46
+ field_count = 55
47
+ recursive_field_count = 55
48
+ fields_from = "All 54 Opportunity table declarations plus Id."
49
+
50
+ [entities.Case]
51
+ entity = "sf_cases"
52
+ field_count = 51
53
+ recursive_field_count = 51
54
+ fields_from = "All 50 Case table declarations plus Id."
55
+
56
+ [entities.Task]
57
+ entity = "sf_tasks"
58
+ field_count = 40
59
+ recursive_field_count = 40
60
+ fields_from = "All 39 Task table declarations plus Id."
61
+
62
+ [keys]
63
+ overrides = []
64
+ unique = [{ entity = "sf_users", fields = ["Username"], evidence = "The pinned User page states that Username must be unique across all organizations." }]
65
+ unique_semantics = "Username is optional in sparse SOQL projections; missing/null values do not conflict, while equal present non-null values do."
66
+
67
+ # Single-target references to one of the seven modelled objects. All compile to
68
+ # restrict relationships. References to objects outside this allowlist remain ids.
69
+ relationships = [
70
+ { entity = "sf_users", field = "AccountId", target = "sf_accounts" },
71
+ { entity = "sf_users", field = "ContactId", target = "sf_contacts" },
72
+ { entity = "sf_users", field = "ManagerId", target = "sf_users" },
73
+ { entity = "sf_accounts", field = "MasterRecordId", target = "sf_accounts" },
74
+ { entity = "sf_accounts", field = "OwnerId", target = "sf_users" },
75
+ { entity = "sf_accounts", field = "ParentId", target = "sf_accounts" },
76
+ { entity = "sf_accounts", field = "PersonReportsToId", target = "sf_contacts" },
77
+ { entity = "sf_contacts", field = "AccountId", target = "sf_accounts" },
78
+ { entity = "sf_contacts", field = "MasterRecordId", target = "sf_contacts" },
79
+ { entity = "sf_contacts", field = "OwnerId", target = "sf_users" },
80
+ { entity = "sf_contacts", field = "ReportsToId", target = "sf_contacts" },
81
+ { entity = "sf_leads", field = "ConvertedAccountId", target = "sf_accounts" },
82
+ { entity = "sf_leads", field = "ConvertedContactId", target = "sf_contacts" },
83
+ { entity = "sf_leads", field = "ConvertedOpportunityId", target = "sf_opportunities" },
84
+ { entity = "sf_leads", field = "MasterRecordId", target = "sf_leads" },
85
+ { entity = "sf_opportunities", field = "AccountId", target = "sf_accounts" },
86
+ { entity = "sf_opportunities", field = "OwnerId", target = "sf_users" },
87
+ { entity = "sf_cases", field = "AccountId", target = "sf_accounts" },
88
+ { entity = "sf_cases", field = "ContactId", target = "sf_contacts" },
89
+ { entity = "sf_cases", field = "MasterRecordId", target = "sf_cases" },
90
+ { entity = "sf_cases", field = "ParentId", target = "sf_cases" },
91
+ { entity = "sf_tasks", field = "AccountId", target = "sf_accounts" },
92
+ ]
93
+
94
+ [[polymorphic]]
95
+ entity = "sf_tasks"
96
+ field = "WhoId"
97
+ reference_to = ["Contact", "Lead"]
98
+ reason = "Multiple vendor targets cannot be represented by one gateway relationship."
99
+
100
+ [[polymorphic]]
101
+ entity = "sf_tasks"
102
+ field = "WhatId"
103
+ reference_to = ["Account", "Opportunity", "Case", "many standard objects", "custom objects"]
104
+ reason = "The vendor target set is open and tenant-dependent."
105
+
106
+ [[polymorphic]]
107
+ entity = "sf_accounts"
108
+ field = "PersonActionCadenceAssigneeId"
109
+ reference_to = ["Group", "User"]
110
+ reason = "The pinned declaration names multiple targets."
111
+
112
+ [[polymorphic]]
113
+ entity = "sf_leads"
114
+ field = "OwnerId"
115
+ reference_to = ["Group", "User"]
116
+ reason = "The pinned declaration names multiple targets."
117
+
118
+ [[polymorphic]]
119
+ entity = "sf_cases"
120
+ field = "OwnerId"
121
+ reference_to = ["Group", "User"]
122
+ reason = "The pinned declaration names multiple targets."
123
+
124
+ [[polymorphic]]
125
+ entity = "sf_tasks"
126
+ field = "OwnerId"
127
+ reference_to = ["Group", "User"]
128
+ reason = "The pinned declaration names multiple targets."
129
+
130
+ [[exclusions]]
131
+ name = "org custom objects and fields (__c)"
132
+ reason = "Org-defined by definition; describe-on-bind supplies additive entities and fields."
133
+
134
+ [[exclusions]]
135
+ name = "enabled-feature fields absent from the pinned pages"
136
+ reason = "The pages include many feature-conditional fields, but only org describe can enumerate the actual enabled set."
137
+
138
+ [[exclusions]]
139
+ name = "common audit fields omitted by object-specific tables"
140
+ reason = "The pinned pages omit Salesforce's common field block. Id is added because it is the documented key; IsDeleted is retained where a page declares it. CreatedDate, CreatedById, LastModifiedDate, LastModifiedById and SystemModstamp require a separately pinned common-fields declaration or live describe."
141
+
142
+ [[exclusions]]
143
+ name = "closed enums for org-controlled picklists"
144
+ reason = "StageName, Lead.Status, Case Status/Priority/Origin, Account Industry/Type and other administrator-controlled picklists remain strings. Default and illustrative prose values are not fabricated into closed enums; explicit value blocks only are enums."
145
+
146
+ [[exclusions]]
147
+ name = "references to objects outside the seven-object allowlist"
148
+ reason = "The fields remain vendor-shaped ids, but no placeholder entity or unenforceable relationship is fabricated."
149
+
150
+ [[exclusions]]
151
+ name = "Change Data Capture fixtures"
152
+ reason = "No event entity is in scope. CDC evidence and synthetic fixtures remain a separate future expansion."
153
+
154
+ [requiredness]
155
+ entity_rule = "Entity properties are the union of documented read/create forms. Their intersection, constrained by storage identity, is Id only, allowing sparse SOQL projections that include the key."
156
+ opportunity_create_rule = "OpportunityCreate includes all documented Create fields and requires Name, StageName and CloseDate, plus caller-supplied Id as a deterministic-world deviation. Salesforce-defaulted OwnerId is optional."
157
+ compound_section_rule = "Each compound address is nullable; when present, the whole returned section requires its eight members, each independently nullable."
158
+
159
+ [compiler_limitations]
160
+ nullable_unique = "Sparse optional uniqueness is supported; sf_users.Username is declared unique without requiring it on every SOQL projection."
161
+ polymorphic_relationships = "WhoId, WhatId and Group-or-User references remain ids without foreign keys."
162
+ date_format = "Date values use format date with exact length 10."
163
+ conditional_fields = "Edition, feature, record-type and page-layout conditions cannot be encoded because conditional schema keywords are unsupported."
164
+ id_shape = "Salesforce ids are 15 or 18 characters; the compiler cannot express that disjunction on relationship/key scalars without composition that key resolution rejects, so base Id remains under-constrained."
165
+ id_generation = "Salesforce generates Id on create; the deterministic store has no id generator, so create_opportunity requires a caller-supplied Id."
166
+ picklist_overlay = "The additive overlay cannot remove skeleton enum values, so org-controlled picklists stay open strings."
167
+
168
+ [verification_requirements]
169
+ sandbox = "Developer Edition org or scratch org via Dev Hub"
170
+ sandbox_available_for_authoring = false
171
+ describe_on_bind = true
172
+ golden_replay = "skipped"
173
+ round_trip = "skipped"
174
+ label = "subset"