@openpolicy/sdk 0.0.11 → 0.0.12

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 (6) hide show
  1. package/README.md +34 -30
  2. package/dist/index.d.ts +1 -4
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +1 -10
  5. package/dist/index.js.map +1 -1
  6. package/package.json +2 -2
package/README.md CHANGED
@@ -16,33 +16,35 @@ bun add @openpolicy/sdk
16
16
  ### Privacy policy
17
17
 
18
18
  ```ts
19
- // privacy.config.ts
20
- import { definePrivacyPolicy } from "@openpolicy/sdk";
19
+ // openpolicy.ts
20
+ import { defineConfig } from "@openpolicy/sdk";
21
21
 
22
- export default definePrivacyPolicy({
23
- effectiveDate: "2026-01-01",
22
+ export default defineConfig({
24
23
  company: {
25
24
  name: "Acme",
26
25
  legalName: "Acme, Inc.",
27
26
  address: "123 Main St, San Francisco, CA 94105",
28
27
  contact: "privacy@acme.com",
29
28
  },
30
- dataCollected: {
31
- "Account information": ["Email address", "Display name"],
32
- "Usage data": ["Pages visited", "Session duration"],
29
+ privacy: {
30
+ effectiveDate: "2026-01-01",
31
+ dataCollected: {
32
+ "Account information": ["Email address", "Display name"],
33
+ "Usage data": ["Pages visited", "Session duration"],
34
+ },
35
+ legalBasis: "Legitimate interests and user consent",
36
+ retention: {
37
+ "Account data": "Until account deletion",
38
+ "Analytics data": "13 months",
39
+ },
40
+ cookies: { essential: true, analytics: true, marketing: false },
41
+ thirdParties: [
42
+ { name: "Vercel", purpose: "Hosting" },
43
+ { name: "Plausible", purpose: "Privacy-friendly analytics" },
44
+ ],
45
+ userRights: ["access", "erasure", "portability"],
46
+ jurisdictions: ["us", "eu"],
33
47
  },
34
- legalBasis: "Legitimate interests and user consent",
35
- retention: {
36
- "Account data": "Until account deletion",
37
- "Analytics data": "13 months",
38
- },
39
- cookies: { essential: true, analytics: true, marketing: false },
40
- thirdParties: [
41
- { name: "Vercel", purpose: "Hosting" },
42
- { name: "Plausible", purpose: "Privacy-friendly analytics" },
43
- ],
44
- userRights: ["access", "erasure", "portability"],
45
- jurisdictions: ["us", "eu"],
46
48
  });
47
49
  ```
48
50
 
@@ -50,24 +52,26 @@ export default definePrivacyPolicy({
50
52
 
51
53
  ```ts
52
54
  // terms.config.ts
53
- import { defineTermsOfService } from "@openpolicy/sdk";
55
+ import { defineConfig } from "@openpolicy/sdk";
54
56
 
55
- export default defineTermsOfService({
56
- effectiveDate: "2026-01-01",
57
+ export default defineConfig({
57
58
  company: {
58
59
  name: "Acme",
59
60
  legalName: "Acme, Inc.",
60
61
  address: "123 Main St, San Francisco, CA 94105",
61
62
  contact: "legal@acme.com",
62
63
  },
63
- acceptance: { methods: ["using the service", "creating an account"] },
64
- eligibility: { minimumAge: 13 },
65
- disclaimers: { serviceProvidedAsIs: true, noWarranties: true },
66
- limitationOfLiability: { excludesIndirectDamages: true },
67
- governingLaw: { jurisdiction: "Delaware, USA" },
68
- changesPolicy: {
69
- noticeMethod: "email or prominent notice on the website",
70
- noticePeriodDays: 30,
64
+ terms: {
65
+ effectiveDate: "2026-01-01",
66
+ acceptance: { methods: ["using the service", "creating an account"] },
67
+ eligibility: { minimumAge: 13 },
68
+ disclaimers: { serviceProvidedAsIs: true, noWarranties: true },
69
+ limitationOfLiability: { excludesIndirectDamages: true },
70
+ governingLaw: { jurisdiction: "Delaware, USA" },
71
+ changesPolicy: {
72
+ noticeMethod: "email or prominent notice on the website",
73
+ noticePeriodDays: 30,
74
+ },
71
75
  },
72
76
  });
73
77
  ```
package/dist/index.d.ts CHANGED
@@ -130,9 +130,6 @@ type OpenPolicyConfig = {
130
130
  //#endregion
131
131
  //#region src/index.d.ts
132
132
  declare function defineConfig(config: OpenPolicyConfig): OpenPolicyConfig;
133
- declare function definePrivacyPolicy(config: PrivacyPolicyConfig): PrivacyPolicyConfig;
134
- declare function defineTermsOfService(config: TermsOfServiceConfig): TermsOfServiceConfig;
135
- declare function defineCookiePolicy(config: CookiePolicyConfig): CookiePolicyConfig;
136
133
  //#endregion
137
- export { type CookiePolicyConfig, type OpenPolicyConfig, type PrivacyPolicyConfig, type TermsOfServiceConfig, defineConfig, defineCookiePolicy, definePrivacyPolicy, defineTermsOfService };
134
+ export { type CookiePolicyConfig, type OpenPolicyConfig, type PrivacyPolicyConfig, type TermsOfServiceConfig, defineConfig };
138
135
  //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","names":["OutputFormat","CompileOptions","formats","PolicySection","id","title","body","Jurisdiction","CompanyConfig","name","legalName","address","contact","PrivacyPolicyConfig","Record","effectiveDate","company","dataCollected","legalBasis","retention","cookies","essential","analytics","marketing","thirdParties","purpose","userRights","jurisdictions","children","underAge","noticeUrl","DisputeResolutionMethod","TermsOfServiceConfig","acceptance","methods","eligibility","minimumAge","jurisdictionRestrictions","accounts","registrationRequired","userResponsibleForCredentials","companyCanTerminate","prohibitedUses","userContent","usersOwnContent","licenseGrantedToCompany","licenseDescription","companyCanRemoveContent","intellectualProperty","companyOwnsService","usersMayNotCopy","payments","hasPaidFeatures","refundPolicy","priceChangesNotice","availability","noUptimeGuarantee","maintenanceWindows","termination","userCanTerminate","effectOfTermination","disclaimers","serviceProvidedAsIs","noWarranties","limitationOfLiability","excludesIndirectDamages","liabilityCap","indemnification","userIndemnifiesCompany","scope","thirdPartyServices","disputeResolution","method","venue","classActionWaiver","governingLaw","jurisdiction","changesPolicy","noticeMethod","noticePeriodDays","privacyPolicyUrl","CookiePolicyConfig","functional","policyUrl","trackingTechnologies","consentMechanism","hasBanner","hasPreferencePanel","canWithdraw","PolicyInput","type","OpenPolicyConfig","Omit","privacy","terms","cookie","isOpenPolicyConfig","value","ValidationIssue","level","message","compileCookiePolicy","config","options","format","content","sections","compilePrivacyPolicy","compileTermsOfService","validatePrivacyPolicy","validateCookiePolicy","validateTermsOfService","expandOpenPolicyConfig","compilePolicy","input"],"sources":["../../core/dist/index.d.ts","../src/index.ts"],"mappings":";KAUKO,YAAAA;AAAAA,KACAC,aAAAA;EACHC,IAAAA;EACAC,SAAAA;EACAC,OAAAA;EACAC,OAAAA;AAAAA;AAAAA,KAEGC,mBAAAA;EACHE,aAAAA;EACAC,OAAAA,EAASR,aAAAA;EACTS,aAAAA,EAAeH,MAAAA;EACfI,UAAAA;EACAC,SAAAA,EAAWL,MAAAA;EACXM,OAAAA;IACEC,SAAAA;IACAC,SAAAA;IACAC,SAAAA;EAAAA;EAEFC,YAAAA;IACEf,IAAAA;IACAgB,OAAAA;EAAAA;EAEFC,UAAAA;EACAC,aAAAA,EAAepB,YAAAA;EACfqB,QAAAA;IACEC,QAAAA;IACAC,SAAAA;EAAAA;AAAAA;AAAAA,KAGCC,uBAAAA;AAAAA,KACAC,oBAAAA;EACHjB,aAAAA;EACAC,OAAAA,EAASR,aAAAA;EACTyB,UAAAA;IACEC,OAAAA;EAAAA;EAEFC,WAAAA;IACEC,UAAAA;IACAC,wBAAAA;EAAAA;EAEFC,QAAAA;IACEC,oBAAAA;IACAC,6BAAAA;IACAC,mBAAAA;EAAAA;EAEFC,cAAAA;EACAC,WAAAA;IACEC,eAAAA;IACAC,uBAAAA;IACAC,kBAAAA;IACAC,uBAAAA;EAAAA;EAEFC,oBAAAA;IACEC,kBAAAA;IACAC,eAAAA;EAAAA;EAEFC,QAAAA;IACEC,eAAAA;IACAC,YAAAA;IACAC,kBAAAA;EAAAA;EAEFC,YAAAA;IACEC,iBAAAA;IACAC,kBAAAA;EAAAA;EAEFC,WAAAA;IACEjB,mBAAAA;IACAkB,gBAAAA;IACAC,mBAAAA;EAAAA;EAEFC,WAAAA;IACEC,mBAAAA;IACAC,YAAAA;EAAAA;EAEFC,qBAAAA;IACEC,uBAAAA;IACAC,YAAAA;EAAAA;EAEFC,eAAAA;IACEC,sBAAAA;IACAC,KAAAA;EAAAA;EAEFC,kBAAAA;IACE7D,IAAAA;IACAgB,OAAAA;EAAAA;EAEF8C,iBAAAA;IACEC,MAAAA,EAAQzC,uBAAAA;IACR0C,KAAAA;IACAC,iBAAAA;EAAAA;EAEFC,YAAAA;IACEC,YAAAA;EAAAA;EAEFC,aAAAA;IACEC,YAAAA;IACAC,gBAAAA;EAAAA;EAEFC,gBAAAA;AAAAA;AAAAA,KAEGC,kBAAAA;EACHlE,aAAAA;EACAC,OAAAA,EAASR,aAAAA;EACTY,OAAAA;IACEC,SAAAA;IACAC,SAAAA;IACA4D,UAAAA;IACA3D,SAAAA;EAAAA;EAEFC,YAAAA;IACEf,IAAAA;IACAgB,OAAAA;IACA0D,SAAAA;EAAAA;EAEFC,oBAAAA;EACAC,gBAAAA;IACEC,SAAAA;IACAC,kBAAAA;IACAC,WAAAA;EAAAA;EAEF7D,aAAAA,EAAepB,YAAAA;AAAAA;AAAAA,KASZoF,gBAAAA;EACH3E,OAAAA,EAASR,aAAAA;EACTqF,OAAAA,GAAUD,IAAAA,CAAK/E,mBAAAA;EACfiF,KAAAA,GAAQF,IAAAA,CAAK5D,oBAAAA;EACb+D,MAAAA,GAASH,IAAAA,CAAKX,kBAAAA;AAAAA;;;iBCjIA,YAAA,CAAa,MAAA,EAAQ,gBAAA,GAAmB,gBAAA;AAAA,iBAIxC,mBAAA,CACf,MAAA,EAAQ,mBAAA,GACN,mBAAA;AAAA,iBAIa,oBAAA,CACf,MAAA,EAAQ,oBAAA,GACN,oBAAA;AAAA,iBAIa,kBAAA,CACf,MAAA,EAAQ,kBAAA,GACN,kBAAA"}
1
+ {"version":3,"file":"index.d.ts","names":["OutputFormat","CompileOptions","formats","PolicySection","id","title","body","Jurisdiction","CompanyConfig","name","legalName","address","contact","PrivacyPolicyConfig","Record","effectiveDate","company","dataCollected","legalBasis","retention","cookies","essential","analytics","marketing","thirdParties","purpose","userRights","jurisdictions","children","underAge","noticeUrl","DisputeResolutionMethod","TermsOfServiceConfig","acceptance","methods","eligibility","minimumAge","jurisdictionRestrictions","accounts","registrationRequired","userResponsibleForCredentials","companyCanTerminate","prohibitedUses","userContent","usersOwnContent","licenseGrantedToCompany","licenseDescription","companyCanRemoveContent","intellectualProperty","companyOwnsService","usersMayNotCopy","payments","hasPaidFeatures","refundPolicy","priceChangesNotice","availability","noUptimeGuarantee","maintenanceWindows","termination","userCanTerminate","effectOfTermination","disclaimers","serviceProvidedAsIs","noWarranties","limitationOfLiability","excludesIndirectDamages","liabilityCap","indemnification","userIndemnifiesCompany","scope","thirdPartyServices","disputeResolution","method","venue","classActionWaiver","governingLaw","jurisdiction","changesPolicy","noticeMethod","noticePeriodDays","privacyPolicyUrl","CookiePolicyConfig","functional","policyUrl","trackingTechnologies","consentMechanism","hasBanner","hasPreferencePanel","canWithdraw","PolicyInput","type","OpenPolicyConfig","Omit","privacy","terms","cookie","isOpenPolicyConfig","value","ValidationIssue","level","message","compileCookiePolicy","config","options","format","content","sections","compilePrivacyPolicy","compileTermsOfService","validatePrivacyPolicy","validateCookiePolicy","validateTermsOfService","expandOpenPolicyConfig","compilePolicy","input"],"sources":["../../core/dist/index.d.ts","../src/index.ts"],"mappings":";KAUKO,YAAAA;AAAAA,KACAC,aAAAA;EACHC,IAAAA;EACAC,SAAAA;EACAC,OAAAA;EACAC,OAAAA;AAAAA;AAAAA,KAEGC,mBAAAA;EACHE,aAAAA;EACAC,OAAAA,EAASR,aAAAA;EACTS,aAAAA,EAAeH,MAAAA;EACfI,UAAAA;EACAC,SAAAA,EAAWL,MAAAA;EACXM,OAAAA;IACEC,SAAAA;IACAC,SAAAA;IACAC,SAAAA;EAAAA;EAEFC,YAAAA;IACEf,IAAAA;IACAgB,OAAAA;EAAAA;EAEFC,UAAAA;EACAC,aAAAA,EAAepB,YAAAA;EACfqB,QAAAA;IACEC,QAAAA;IACAC,SAAAA;EAAAA;AAAAA;AAAAA,KAGCC,uBAAAA;AAAAA,KACAC,oBAAAA;EACHjB,aAAAA;EACAC,OAAAA,EAASR,aAAAA;EACTyB,UAAAA;IACEC,OAAAA;EAAAA;EAEFC,WAAAA;IACEC,UAAAA;IACAC,wBAAAA;EAAAA;EAEFC,QAAAA;IACEC,oBAAAA;IACAC,6BAAAA;IACAC,mBAAAA;EAAAA;EAEFC,cAAAA;EACAC,WAAAA;IACEC,eAAAA;IACAC,uBAAAA;IACAC,kBAAAA;IACAC,uBAAAA;EAAAA;EAEFC,oBAAAA;IACEC,kBAAAA;IACAC,eAAAA;EAAAA;EAEFC,QAAAA;IACEC,eAAAA;IACAC,YAAAA;IACAC,kBAAAA;EAAAA;EAEFC,YAAAA;IACEC,iBAAAA;IACAC,kBAAAA;EAAAA;EAEFC,WAAAA;IACEjB,mBAAAA;IACAkB,gBAAAA;IACAC,mBAAAA;EAAAA;EAEFC,WAAAA;IACEC,mBAAAA;IACAC,YAAAA;EAAAA;EAEFC,qBAAAA;IACEC,uBAAAA;IACAC,YAAAA;EAAAA;EAEFC,eAAAA;IACEC,sBAAAA;IACAC,KAAAA;EAAAA;EAEFC,kBAAAA;IACE7D,IAAAA;IACAgB,OAAAA;EAAAA;EAEF8C,iBAAAA;IACEC,MAAAA,EAAQzC,uBAAAA;IACR0C,KAAAA;IACAC,iBAAAA;EAAAA;EAEFC,YAAAA;IACEC,YAAAA;EAAAA;EAEFC,aAAAA;IACEC,YAAAA;IACAC,gBAAAA;EAAAA;EAEFC,gBAAAA;AAAAA;AAAAA,KAEGC,kBAAAA;EACHlE,aAAAA;EACAC,OAAAA,EAASR,aAAAA;EACTY,OAAAA;IACEC,SAAAA;IACAC,SAAAA;IACA4D,UAAAA;IACA3D,SAAAA;EAAAA;EAEFC,YAAAA;IACEf,IAAAA;IACAgB,OAAAA;IACA0D,SAAAA;EAAAA;EAEFC,oBAAAA;EACAC,gBAAAA;IACEC,SAAAA;IACAC,kBAAAA;IACAC,WAAAA;EAAAA;EAEF7D,aAAAA,EAAepB,YAAAA;AAAAA;AAAAA,KASZoF,gBAAAA;EACH3E,OAAAA,EAASR,aAAAA;EACTqF,OAAAA,GAAUD,IAAAA,CAAK/E,mBAAAA;EACfiF,KAAAA,GAAQF,IAAAA,CAAK5D,oBAAAA;EACb+D,MAAAA,GAASH,IAAAA,CAAKX,kBAAAA;AAAAA;;;iBCtIA,YAAA,CAAa,MAAA,EAAQ,gBAAA,GAAmB,gBAAA"}
package/dist/index.js CHANGED
@@ -2,16 +2,7 @@
2
2
  function defineConfig(config) {
3
3
  return config;
4
4
  }
5
- function definePrivacyPolicy(config) {
6
- return config;
7
- }
8
- function defineTermsOfService(config) {
9
- return config;
10
- }
11
- function defineCookiePolicy(config) {
12
- return config;
13
- }
14
5
  //#endregion
15
- export { defineConfig, defineCookiePolicy, definePrivacyPolicy, defineTermsOfService };
6
+ export { defineConfig };
16
7
 
17
8
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type {\n\tCookiePolicyConfig,\n\tOpenPolicyConfig,\n\tPrivacyPolicyConfig,\n\tTermsOfServiceConfig,\n} from \"@openpolicy/core\";\n\nexport type {\n\tCookiePolicyConfig,\n\tOpenPolicyConfig,\n\tPrivacyPolicyConfig,\n\tTermsOfServiceConfig,\n} from \"@openpolicy/core\";\n\nexport function defineConfig(config: OpenPolicyConfig): OpenPolicyConfig {\n\treturn config;\n}\n\nexport function definePrivacyPolicy(\n\tconfig: PrivacyPolicyConfig,\n): PrivacyPolicyConfig {\n\treturn config;\n}\n\nexport function defineTermsOfService(\n\tconfig: TermsOfServiceConfig,\n): TermsOfServiceConfig {\n\treturn config;\n}\n\nexport function defineCookiePolicy(\n\tconfig: CookiePolicyConfig,\n): CookiePolicyConfig {\n\treturn config;\n}\n"],"mappings":";AAcA,SAAgB,aAAa,QAA4C;AACxE,QAAO;;AAGR,SAAgB,oBACf,QACsB;AACtB,QAAO;;AAGR,SAAgB,qBACf,QACuB;AACvB,QAAO;;AAGR,SAAgB,mBACf,QACqB;AACrB,QAAO"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { OpenPolicyConfig } from \"@openpolicy/core\";\n\nexport type {\n\tCookiePolicyConfig,\n\tOpenPolicyConfig,\n\tPrivacyPolicyConfig,\n\tTermsOfServiceConfig,\n} from \"@openpolicy/core\";\n\nexport function defineConfig(config: OpenPolicyConfig): OpenPolicyConfig {\n\treturn config;\n}\n"],"mappings":";AASA,SAAgB,aAAa,QAA4C;AACxE,QAAO"}
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "@openpolicy/sdk",
3
- "version": "0.0.11",
3
+ "version": "0.0.12",
4
4
  "type": "module",
5
5
  "description": "Public API for defining privacy policies with OpenPolicy",
6
- "license": "MIT",
6
+ "license": "GPL-3.0-only",
7
7
  "repository": {
8
8
  "type": "git",
9
9
  "url": "https://github.com/jamiedavenport/openpolicy",