Skip to content

spike: embedded code samples rework #1328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 22 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
f8e06e7
feat: Dart code examples
fundthmcalculus Mar 8, 2023
b75e9bf
feat: dart `AccountService` examples
fundthmcalculus Mar 8, 2023
3f901e8
feat: Macro generate the code sample tabs
fundthmcalculus Mar 9, 2023
d802c26
feat: Add access-management-service
fundthmcalculus Mar 9, 2023
3f90823
feat: Add missing endpoints to the docs
fundthmcalculus Mar 9, 2023
291c42f
no message
fundthmcalculus Mar 9, 2023
5b19994
spike: Empty code files for all samples in every language except the CLI
fundthmcalculus Mar 9, 2023
678d877
Merge branch 'main' into 1759-embedded-code-samples
fundthmcalculus Mar 9, 2023
d4a26c9
feat: Remove AccessManagementService references for now.
fundthmcalculus Mar 10, 2023
ea0d772
fix: Remove CLI
fundthmcalculus Mar 17, 2023
12615e1
feat: Dart sample injection template
fundthmcalculus Mar 17, 2023
cf6a0be
Clean out empty samples
fundthmcalculus Mar 17, 2023
462aef6
no message
fundthmcalculus Mar 17, 2023
3959499
feat: SAMPLE FILES ARE GENERATED
fundthmcalculus Mar 17, 2023
fb597f3
Fix injection targeting and tab rendering
Mar 17, 2023
6fc3542
fix: Mark the `createService()` injection correctly
fundthmcalculus Mar 20, 2023
147622d
fix: Correct the `access_management` service snake_case
fundthmcalculus Mar 23, 2023
d325ee6
spike: AccessManagementService
fundthmcalculus Mar 23, 2023
fc5639f
spike: All create service options
fundthmcalculus Mar 23, 2023
9072ce6
feat: Python docs, almost complete
fundthmcalculus Mar 23, 2023
a485476
fix: Output enum types
fundthmcalculus Mar 23, 2023
a0a51a0
fix: Repeated types
fundthmcalculus Mar 23, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions dart/example/accessmanagement_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\accessmanagement_service_examples.dart

// createAccessManagementService() {
// }

// accessManagementAddRoleAssignment() {
// }

// accessManagementRemoveRoleAssignment() {
// }

// accessManagementListRoleAssignments() {
// }

// accessManagementListAvailableRoles() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
65 changes: 65 additions & 0 deletions dart/example/account_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
import 'dart:convert';
// createAccountService() {
import 'package:trinsic_dart/src/account_service.dart';
import 'package:trinsic_dart/src/proto/services/account/v1/account.pb.dart';
import 'package:trinsic_dart/src/trinsic_service.dart';
import 'package:trinsic_dart/src/trinsic_util.dart';

Future<AccountService> getAccountService() async {
var trinsic = TrinsicService(trinsicConfig(authToken: "[YOURAUTHTOKEN]"), null);
var accountService = trinsic.account();
return accountService;
}
// }

Future runAccountServiceExamples() async {
var accountService = await getAccountService();

// TODO - Handle this code reliably?
try {
// accountServiceLogin() {
var loginResponse = await accountService.login(request: LoginRequest(
ecosystemId: "your-ecosystem-id", email: "email@example.com"));
var profile = await accountService.loginConfirm(
Base64Encoder().convert(loginResponse.challenge), "[YOURCODE]");
// }
} catch (e) {
// This is expected error due to invalid codes
}

// accountServiceLoginAnonymous() {
var anonymousProfile = await accountService.loginAnonymous(ecosystemId: "your-ecosystem-id");
// }

// accountServiceInfo() {
var info = await accountService.info();
print('Account info: EcosystemId=${info.ecosystemId} Email=${info.details.email}');
// }
}

void main() async {
await runAccountServiceExamples();
}

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\account_service_examples.dart

// createAccountService
// }

// accountSignIn() {
// }

// accountLogin() {
// }

// accountLoginConfirm() {
// }

// accountInfo() {
// }

// accountAuthorizeWebhook() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
42 changes: 42 additions & 0 deletions dart/example/credential_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import 'dart:convert';
// createCredentialService() {
import 'package:trinsic_dart/src/credential_service.dart';
import 'package:trinsic_dart/src/proto/services/account/v1/account.pb.dart';
import 'package:trinsic_dart/src/trinsic_service.dart';
import 'package:trinsic_dart/src/trinsic_util.dart';

Future<CredentialService> getCredentialService() async {
var trinsic = TrinsicService(trinsicConfig(authToken: "[YOURAUTHTOKEN]"), null);
var credentialService = trinsic.credential();
return credentialService;
}
// }

Future runCredentialServiceExamples() async {
var accountService = await getCredentialService();

// TODO - Handle this code reliably?
try {
// accountServiceLoginLoginConfirm() {
var loginResponse = await accountService.login(request: LoginRequest(
ecosystemId: "your-ecosystem-id", email: "email@example.com"));
var profile = await accountService.loginConfirm(
Base64Encoder().convert(loginResponse.challenge), "[YOURCODE]");
// }
} catch (e) {
// This is expected error due to invalid codes
}

// accountServiceLoginAnonymous() {
var anonymousProfile = await accountService.loginAnonymous(ecosystemId: "your-ecosystem-id");
// }

// accountServiceGetInfo() {
var info = await accountService.info();
print('Account info: EcosystemId=${info.ecosystemId} Email=${info.details.email}');
// }
}

void main() async {
await runCredentialServiceExamples();
}
26 changes: 26 additions & 0 deletions dart/example/credentialtemplates_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\credentialtemplates_service_examples.dart

// createCredentialTemplatesService() {
// }

// credentialTemplatesCreate() {
// }

// credentialTemplatesGet() {
// }

// credentialTemplatesUpdate() {
// }

// credentialTemplatesList() {
// }

// credentialTemplatesSearch() {
// }

// credentialTemplatesDelete() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
2 changes: 1 addition & 1 deletion dart/example/ecosystem_example.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import 'package:trinsic_dart/trinsic.dart';

Future runEcosystemDemo() async {
var trinsic = TrinsicService(trinsicConfig(), null);
var account = await trinsic.account().loginAnonymous("default");
var account = await trinsic.account().loginAnonymous(ecosystemId: "default");
assert(account.isNotEmpty);
// createEcosystem() {
var actualCreate = await trinsic.provider().createEcosystem(
Expand Down
23 changes: 23 additions & 0 deletions dart/example/filemanagement_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\filemanagement_service_examples.dart

// createFileManagementService() {
// }

// fileManagementUploadFile() {
// }

// fileManagementGetFile() {
// }

// fileManagementDeleteFile() {
// }

// fileManagementListFiles() {
// }

// fileManagementGetStorageStats() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
47 changes: 47 additions & 0 deletions dart/example/provider_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\provider_service_examples.dart

// createProviderService() {
// }

// providerCreateEcosystem() {
// }

// providerUpdateEcosystem() {
// }

// providerAddWebhook() {
// }

// providerDeleteWebhook() {
// }

// providerEcosystemInfo() {
// }

// providerGetPublicEcosystemInfo() {
// }

// providerInvite() {
// }

// providerInvitationStatus() {
// }

// providerGetOberonKey() {
// }

// providerUpgradeDID() {
// }

// providerRetrieveDomainVerificationRecord() {
// }

// providerRefreshDomainVerificationStatus() {
// }

// providerSearchWalletConfigurations() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
2 changes: 1 addition & 1 deletion dart/example/templates_demo.dart
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import 'package:uuid/uuid.dart';

Future runTemplatesDemo() async {
var trinsic = TrinsicService(trinsicConfig(), null);
var profile = await trinsic.account().loginAnonymous("default");
var profile = await trinsic.account().loginAnonymous(ecosystemId: "default");
assert(profile.isNotEmpty);

var uuid = Uuid();
Expand Down
2 changes: 1 addition & 1 deletion dart/example/trustregistry_demo.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import 'package:uuid/uuid.dart';

Future runTrustRegistryDemo() async {
var trinsic = TrinsicService(trinsicConfig(), null);
var account = await trinsic.account().loginAnonymous("default");
var account = await trinsic.account().loginAnonymous(ecosystemId: "default");

var uuid = Uuid();

Expand Down
29 changes: 29 additions & 0 deletions dart/example/trustregistry_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\trustregistry_service_examples.dart

// createTrustRegistryService() {
// }

// trustRegistryAddFramework() {
// }

// trustRegistryRemoveFramework() {
// }

// trustRegistrySearchRegistry() {
// }

// trustRegistryRegisterMember() {
// }

// trustRegistryUnregisterMember() {
// }

// trustRegistryGetMembershipStatus() {
// }

// trustRegistryFetchData() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
26 changes: 26 additions & 0 deletions dart/example/universalwallet_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\universalwallet_service_examples.dart

// createUniversalWalletService() {
// }

// universalWalletGetItem() {
// }

// universalWalletSearch() {
// }

// universalWalletInsertItem() {
// }

// universalWalletUpdateItem() {
// }

// universalWalletDeleteItem() {
// }

// universalWalletDeleteWallet() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
6 changes: 3 additions & 3 deletions dart/example/vaccine_example.dart
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Future runVaccineDemo() async {

// setupActors() {
// Create 3 different profiles for each participant in the scenario
var allison = await trinsic.account().loginAnonymous(ecosystemId);
var clinic = await trinsic.account().loginAnonymous(ecosystemId);
var airline = await trinsic.account().loginAnonymous(ecosystemId);
var allison = await trinsic.account().loginAnonymous(ecosystemId: ecosystemId);
var clinic = await trinsic.account().loginAnonymous(ecosystemId: ecosystemId);
var airline = await trinsic.account().loginAnonymous(ecosystemId: ecosystemId);
// }

trinsic.serviceOptions.authToken = clinic;
Expand Down
29 changes: 29 additions & 0 deletions dart/example/verifiablecredential_service_examples.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

// BEGIN Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
// target: C:\work\sdk\dart\example\verifiablecredential_service_examples.dart

// createVerifiableCredentialService() {
// }

// verifiableCredentialIssue() {
// }

// verifiableCredentialIssueFromTemplate() {
// }

// verifiableCredentialCheckStatus() {
// }

// verifiableCredentialUpdateStatus() {
// }

// verifiableCredentialCreateProof() {
// }

// verifiableCredentialVerifyProof() {
// }

// verifiableCredentialSend() {
// }

// END Doc Code generated by protoc-gen-trinsic. DO NOT EDIT.
Loading