diff --git a/.mkrepo/main.w b/.mkrepo/main.w index 950524e0..59275533 100644 --- a/.mkrepo/main.w +++ b/.mkrepo/main.w @@ -9,6 +9,7 @@ bring "./stale.w" as stale; bring "./readme.w" as readme; let workflowdir = ".github/workflows"; +let skippedLibrariesPath = "SKIPPED_LIBRARIES.json"; // clean up fs.remove(workflowdir); @@ -37,10 +38,16 @@ new checkconfig.CheckConfigWorkflow(workflowdir); new prlint.PullRequestLintWorkflow(workflowdir, libs.copy()); new gitattributes.GitAttributes(); -let skipCanaryTests = [ - "containers", // https://github.com/winglang/wing/issues/5716 - "cognito", // https://github.com/winglang/wing/issues/6924 - "python", // https://github.com/winglang/wing/issues/6923 -]; +struct SkippedLibrary { + name: str; + reason: str; +} + +let skippedLibrariesData: Array = unsafeCast(fs.readJson(skippedLibrariesPath)["skipped-packages"]); +let skippedLibraries = MutArray[]; +for item in skippedLibrariesData { + skippedLibraries.push(item.name); +} +log("Libraries skipped for end-to-end tests: {Json.stringify(skippedLibraries)}"); -new canary.CanaryWorkflow(workflowdir, libs.copy(), skipCanaryTests); +new canary.CanaryWorkflow(workflowdir, libs.copy(), skippedLibraries.copy()); diff --git a/SKIPPED_LIBRARIES.json b/SKIPPED_LIBRARIES.json new file mode 100644 index 00000000..119746e1 --- /dev/null +++ b/SKIPPED_LIBRARIES.json @@ -0,0 +1,16 @@ +{ + "skipped-packages": [ + { + "name": "containers", + "reason": "https://github.com/winglang/wing/issues/5716" + }, + { + "name": "cognito", + "reason": "https://github.com/winglang/wing/issues/6924" + }, + { + "name": "python", + "reason": "https://github.com/winglang/wing/issues/6923" + } + ] +} diff --git a/bedrock/API.md b/bedrock/API.md new file mode 100644 index 00000000..345f2def --- /dev/null +++ b/bedrock/API.md @@ -0,0 +1,46 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - JokeMaker + - Model + +

JokeMaker (preflight class)

+ +

Constructor

+ +
+new(): JokeMaker
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight makeJoke(topic: str): str | *No description* | + +

Model (preflight class)

+ +

Constructor

+ +
+new(modelId: str): Model
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| modelId | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight invoke(body: Json): Json | *No description* | + diff --git a/bedrock/package-lock.json b/bedrock/package-lock.json index 7687e399..479b4b10 100644 --- a/bedrock/package-lock.json +++ b/bedrock/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/bedrock", - "version": "0.1.0", + "version": "0.1.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/bedrock", - "version": "0.1.0", + "version": "0.1.1", "license": "MIT", "peerDependencies": { "@aws-sdk/client-bedrock-runtime": "^3.484.0" diff --git a/bedrock/package.json b/bedrock/package.json index 7d511678..802ce226 100644 --- a/bedrock/package.json +++ b/bedrock/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/bedrock", "description": "A Wing library for Amazon Bedrock", - "version": "0.1.0", + "version": "0.1.1", "author": { "name": "Eyal Keren", "email": "eyalk@wing.cloud" diff --git a/budget/API.md b/budget/API.md new file mode 100644 index 00000000..74a500aa --- /dev/null +++ b/budget/API.md @@ -0,0 +1,113 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Alert + - AlertTfAws + - AlertSim + - Util +- **Interfaces** + - IAlert +- **Structs** + - AlertProps +- **Enums** + - TimeUnit + +

Alert (preflight class)

+ +

Constructor

+ +
+new(props: AlertProps): Alert
+
+ +

Properties

+ +*No properties* + +

Methods

+ +*No methods* + +

AlertTfAws (preflight class)

+ +

Constructor

+ +
+new(props: AlertProps): AlertTfAws
+
+ +

Properties

+ +*No properties* + +

Methods

+ +*No methods* + +

AlertSim (preflight class)

+ +

Constructor

+ +
+new(props: AlertProps): AlertSim
+
+ +

Properties

+ +*No properties* + +

Methods

+ +*No methods* + +

Util (preflight class)

+ +

Constructor

+ +
+new(): Util
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static timeUnitToStr(timeUnit: TimeUnit): str | *No description* | + +

IAlert (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +*No methods* + +

AlertProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| amount | num | *No description* | +| emailAddresses | Array | *No description* | +| name | str | *No description* | +| timeUnit | TimeUnit? | *No description* | + +

TimeUnit (enum)

+ +

Values

+ +| **Name** | **Description** | +| --- | --- | +| DAILY | *No description* | +| MONTHLY | *No description* | +| ANNUALLY | *No description* | + diff --git a/budget/package-lock.json b/budget/package-lock.json index 78e14622..7bd0d635 100644 --- a/budget/package-lock.json +++ b/budget/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/budget", - "version": "0.1.5", + "version": "0.1.6", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/budget", - "version": "0.1.5", + "version": "0.1.6", "license": "MIT", "peerDependencies": { "@cdktf/provider-aws": "^19.12.0", diff --git a/budget/package.json b/budget/package.json index 7561d9af..5b150954 100644 --- a/budget/package.json +++ b/budget/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/budget", - "version": "0.1.5", + "version": "0.1.6", "description": "AWS Budget", "keywords": [ "AWS", diff --git a/bump-all.sh b/bump-all.sh index 894fd7a5..7c88e18c 100755 --- a/bump-all.sh +++ b/bump-all.sh @@ -15,21 +15,42 @@ increment_patch_version() { echo "${version_parts[0]}.${version_parts[1]}.${version_parts[2]}" } +# Read the skipped packages from the JSON file +skipped_packages=$(jq -r '.["skipped-packages"][].name' SKIPPED_LIBRARIES.json) + # Find all package.json files in subdirectories for package_file in */package.json; do # Check if the package.json file exists - if [[ -f "$package_file" ]]; then - # Extract the current version - current_version=$(jq -r '.version' "$package_file") - - # Increment the patch version - new_version=$(increment_patch_version "$current_version") - - # Update the version in package.json - jq --arg new_version "$new_version" '.version = $new_version' "$package_file" > temp.json && mv temp.json "$package_file" - - echo "Updated $package_file from $current_version to $new_version" - else - echo "No package.json found in $package_file" + if [[ ! -f "$package_file" ]]; then + continue + fi + + package_name="${package_file%/package.json}" + + echo "-----------------------------------------------------------------------------" + echo $package_name + echo "-----------------------------------------------------------------------------" + + # Check if the package should be skipped + if echo "$skipped_packages" | grep -q "^$package_name$"; then + echo "Skipping $package_name" + continue fi + + # Extract the current version + current_version=$(jq -r '.version' "$package_file") + + # Increment the patch version + new_version=$(increment_patch_version "$current_version") + + # Update the version in package.json + jq --arg new_version "$new_version" '.version = $new_version' "$package_file" > temp.json && mv temp.json "$package_file" + + # Run npm install to update package-lock.json + ( + cd "$package_name" + npm install + ) + + echo "Updated $package_name from $current_version to $new_version" done diff --git a/checks/API.md b/checks/API.md new file mode 100644 index 00000000..98c3146f --- /dev/null +++ b/checks/API.md @@ -0,0 +1,122 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Results + - Check + - CheckHttp +- **Interfaces** + - ICheck +- **Structs** + - CheckResult + - CheckProps + - CheckHttpProps + +

Results (preflight class)

+ +

Constructor

+ +
+new(): Results
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight latest(checkid: str): CheckResult? | *No description* | +| static of(scope: IResource): Results | *No description* | +| inflight store(result: CheckResult): void | *No description* | + +

Check (preflight class)

+ +

Constructor

+ +
+new(handler: inflight (): void, props: CheckProps?): Check
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight latest(): CheckResult? | *No description* | +| inflight run(): CheckResult | *No description* | + +

CheckHttp (preflight class)

+ +

Constructor

+ +
+new(url: str, options: CheckHttpProps?): CheckHttp
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight latest(): CheckResult? | *No description* | +| inflight run(): CheckResult | *No description* | + +

ICheck (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight latest(): CheckResult? | *No description* | +| inflight run(): CheckResult | *No description* | + +

CheckResult (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| checkid | str | *No description* | +| checkpath | str | *No description* | +| error | str? | *No description* | +| ok | bool | *No description* | +| timestamp | str | *No description* | + +

CheckProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| deploy | bool? | *No description* | +| rate | duration? | *No description* | +| testing | bool? | *No description* | + +

CheckHttpProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| body | str? | *No description* | +| deploy | bool? | *No description* | +| method | HttpMethod? | *No description* | +| path | str? | *No description* | +| rate | duration? | *No description* | +| status | num? | *No description* | +| testing | bool? | *No description* | + diff --git a/checks/package-lock.json b/checks/package-lock.json index 90e37e41..722869a4 100644 --- a/checks/package-lock.json +++ b/checks/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/checks", - "version": "0.0.16", + "version": "0.0.17", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/checks", - "version": "0.0.16", + "version": "0.0.17", "license": "MIT" } } diff --git a/checks/package.json b/checks/package.json index 0c1a2995..a100a53e 100644 --- a/checks/package.json +++ b/checks/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/checks", - "version": "0.0.16", + "version": "0.0.17", "description": "Cloud checks", "publishConfig": { "access": "public", diff --git a/cloudv2/API.md b/cloudv2/API.md new file mode 100644 index 00000000..e64aae45 --- /dev/null +++ b/cloudv2/API.md @@ -0,0 +1,90 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Counter + - AwsCounter +- **Interfaces** + - ICounter + - IAwsCounter +- **Structs** + - CounterProps + +

Counter (preflight class)

+ +

Constructor

+ +
+new(props: CounterProps): Counter
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| initial | num | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight dec(amount: num?, key: str?): num | *No description* | +| inflight inc(amount: num?, key: str?): num | *No description* | +| inflight peek(key: str?): num | *No description* | +| inflight set(value: num, key: str?): void | *No description* | + +

AwsCounter (preflight class)

+ +

Constructor

+ +
+new(): AwsCounter
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static from(c: ICounter): IAwsCounter? | *No description* | + +

ICounter (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight dec(amount: num?, key: str?): num | Decrements the counter atomically by a certain amount and returns the previous value. - `amount` The amount to decrement by (defaults to 1) - `key` The key of the counter (defaults to "default") | +| inflight inc(amount: num?, key: str?): num | Increments the counter atomically by a certain amount and returns the previous value. - `amount` The amount to increment by (defaults to 1) - `key` The key of the counter (defaults to "default") | +| inflight peek(key: str?): num | Returns the current value of the counter. - `key` The key of the counter (defaults to "default") | +| inflight set(value: num, key: str?): void | Sets the value of the counter. - `value` The new value of the counter - `key` The key of the counter (defaults to "default") | + +

IAwsCounter (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| dynamoTableArn(): str | *No description* | +| dynamoTableName(): str | *No description* | + +

CounterProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| initial | num? | The initial value of the counter @default 0 | + diff --git a/cloudv2/package-lock.json b/cloudv2/package-lock.json index c214f0a2..d7bf006a 100644 --- a/cloudv2/package-lock.json +++ b/cloudv2/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/cloudv2", - "version": "0.1.0", + "version": "0.1.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/cloudv2", - "version": "0.1.0", + "version": "0.1.1", "license": "MIT", "peerDependencies": { "@aws-sdk/client-dynamodb": "^3.621.0", diff --git a/cloudv2/package.json b/cloudv2/package.json index 80822664..ba8662db 100644 --- a/cloudv2/package.json +++ b/cloudv2/package.json @@ -5,7 +5,7 @@ "email": "chrisr@wing.cloud", "name": "Chris Rybicki" }, - "version": "0.1.0", + "version": "0.1.1", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/dynamodb/API.md b/dynamodb/API.md new file mode 100644 index 00000000..6334aeab --- /dev/null +++ b/dynamodb/API.md @@ -0,0 +1,525 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Table + - Table_tfaws + - Table_sim + - Client +- **Interfaces** + - IClient + - ITable +- **Structs** + - AttributeDefinition + - ClientConfig + - Connection + - Credentials + - DeleteOptions + - DeleteOutput + - GetOptions + - GetOutput + - GlobalSecondaryIndex + - PutOptions + - PutOutput + - QueryOptions + - QueryOutput + - ScanOptions + - ScanOutput + - StreamConsumerOptions + - StreamRecord + - StreamRecordDynamodb + - TableProps + - TransactWriteItem + - TransactWriteItemConditionCheck + - TransactWriteItemDelete + - TransactWriteItemPut + - TransactWriteItemUpdate + - TransactWriteOptions + - TransactWriteOutput + - UpdateOptions + - UpdateOutput + - ClientProps + +

Table (preflight class)

+ +

Constructor

+ +
+new(props: TableProps): Table
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| connection | Connection | *No description* | +| tableName | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight delete(options: DeleteOptions): DeleteOutput | *No description* | +| inflight get(options: GetOptions): GetOutput | *No description* | +| inflight put(options: PutOptions): PutOutput | *No description* | +| inflight query(options: QueryOptions): QueryOutput | *No description* | +| inflight readWriteConnection(): Connection | *No description* | +| inflight scan(options: ScanOptions?): ScanOutput | *No description* | +| setStreamConsumer(handler: inflight (StreamRecord): void, opts: StreamConsumerOptions?): void | *No description* | +| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput | *No description* | +| inflight update(options: UpdateOptions): UpdateOutput | *No description* | + +

Table_tfaws (preflight class)

+ +

Constructor

+ +
+new(props: TableProps): Table_tfaws
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| connection | Connection | *No description* | +| tableName | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight delete(options: DeleteOptions): DeleteOutput | *No description* | +| inflight get(options: GetOptions): GetOutput | *No description* | +| inflight put(options: PutOptions): PutOutput | *No description* | +| inflight query(options: QueryOptions): QueryOutput | *No description* | +| inflight readWriteConnection(): Connection | *No description* | +| inflight scan(options: ScanOptions?): ScanOutput | *No description* | +| setStreamConsumer(handler: inflight (StreamRecord): void, options: StreamConsumerOptions?): void | *No description* | +| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput | *No description* | +| inflight update(options: UpdateOptions): UpdateOutput | *No description* | + +

Table_sim (preflight class)

+ +

Constructor

+ +
+new(props: TableProps): Table_sim
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| connection | Connection | *No description* | +| tableName | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight delete(options: DeleteOptions): DeleteOutput | *No description* | +| inflight get(options: GetOptions): GetOutput | *No description* | +| inflight put(options: PutOptions): PutOutput | *No description* | +| inflight query(options: QueryOptions): QueryOutput | *No description* | +| inflight readWriteConnection(): Connection | *No description* | +| inflight scan(options: ScanOptions?): ScanOutput | *No description* | +| setStreamConsumer(handler: inflight (StreamRecord): void, options: StreamConsumerOptions?): void | *No description* | +| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput | *No description* | +| inflight update(options: UpdateOptions): UpdateOutput | *No description* | + +

Client (inflight class)

+ +

Constructor

+ +
+new(): Client
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight delete(options: DeleteOptions): DeleteOutput | *No description* | +| inflight get(options: GetOptions): GetOutput | *No description* | +| inflight put(options: PutOptions): PutOutput | *No description* | +| inflight query(options: QueryOptions): QueryOutput | *No description* | +| inflight scan(options: ScanOptions?): ScanOutput | *No description* | +| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput | *No description* | +| inflight update(options: UpdateOptions): UpdateOutput | *No description* | + +

IClient (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight delete(options: DeleteOptions): DeleteOutput | *No description* | +| inflight get(options: GetOptions): GetOutput | *No description* | +| inflight put(options: PutOptions): PutOutput | *No description* | +| inflight query(options: QueryOptions): QueryOutput | *No description* | +| inflight scan(options: ScanOptions?): ScanOutput | *No description* | +| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput | *No description* | +| inflight update(options: UpdateOptions): UpdateOutput | *No description* | + +

ITable (interface)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | Node | The tree node. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight delete(options: DeleteOptions): DeleteOutput | *No description* | +| inflight get(options: GetOptions): GetOutput | *No description* | +| inflight put(options: PutOptions): PutOutput | *No description* | +| inflight query(options: QueryOptions): QueryOutput | *No description* | +| inflight readWriteConnection(): Connection | *No description* | +| inflight scan(options: ScanOptions?): ScanOutput | *No description* | +| setStreamConsumer(handler: inflight (StreamRecord): void, options: StreamConsumerOptions?): void | *No description* | +| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput | *No description* | +| inflight update(options: UpdateOptions): UpdateOutput | *No description* | + +

AttributeDefinition (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | str | *No description* | +| type | str | *No description* | + +

ClientConfig (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| credentials | Credentials | *No description* | +| endpoint | str | *No description* | +| region | str | *No description* | + +

Connection (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| clientConfig | ClientConfig? | *No description* | +| tableName | str | *No description* | + +

Credentials (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| accessKeyId | str | *No description* | +| secretAccessKey | str | *No description* | + +

DeleteOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Key | Json | *No description* | +| ReturnValues | str? | *No description* | + +

DeleteOutput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Attributes | Json? | *No description* | + +

GetOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConsistentRead | bool? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Key | Json | *No description* | +| ProjectionExpression | str? | *No description* | + +

GetOutput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Item | Json? | *No description* | + +

GlobalSecondaryIndex (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| hashKey | str | *No description* | +| name | str | *No description* | +| nonKeyAttributes | Array? | *No description* | +| projectionType | str | *No description* | +| rangeKey | str? | *No description* | +| readCapacity | num? | *No description* | +| writeCapacity | num? | *No description* | + +

PutOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Item | Json | *No description* | +| ReturnValues | str? | *No description* | + +

PutOutput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Attributes | Json? | *No description* | + +

QueryOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConsistentRead | bool? | *No description* | +| ExclusiveStartKey | Json? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| FilterExpression | str? | *No description* | +| IndexName | str? | *No description* | +| KeyConditionExpression | str | *No description* | +| Limit | num? | *No description* | +| ProjectionExpression | str? | *No description* | +| ReturnConsumedCapacity | str? | *No description* | +| ScanIndexForward | bool? | *No description* | +| Select | str? | *No description* | + +

QueryOutput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConsumedCapacity | Json? | *No description* | +| Count | num | *No description* | +| Items | Array | *No description* | +| LastEvaluatedKey | Json? | *No description* | +| ScannedCount | num | *No description* | + +

ScanOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConsistentRead | bool? | *No description* | +| ExclusiveStartKey | Json? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| FilterExpression | str? | *No description* | +| IndexName | str? | *No description* | +| Limit | num? | *No description* | +| ProjectionExpression | str? | *No description* | +| ReturnConsumedCapacity | str? | *No description* | +| Segment | num? | *No description* | +| Select | str? | *No description* | +| TotalSegments | num? | *No description* | + +

ScanOutput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConsumedCapacity | Json? | *No description* | +| Count | num | *No description* | +| Items | Array | *No description* | +| LastEvaluatedKey | Json? | *No description* | +| ScannedCount | num | *No description* | + +

StreamConsumerOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| batchSize | num? | *No description* | +| startingPosition | str? | *No description* | + +

StreamRecord (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| dynamodb | StreamRecordDynamodb | *No description* | +| eventID | str | *No description* | +| eventName | str | *No description* | + +

StreamRecordDynamodb (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ApproximateCreationDateTime | str | *No description* | +| Keys | Json | *No description* | +| NewImage | Json? | *No description* | +| OldImage | Json? | *No description* | +| SequenceNumber | str | *No description* | +| SizeBytes | num | *No description* | +| StreamViewType | str | *No description* | + +

TableProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attributes | Array | *No description* | +| globalSecondaryIndex | Array? | *No description* | +| hashKey | str | *No description* | +| name | str? | *No description* | +| pointInTimeRecovery | bool? | *No description* | +| rangeKey | str? | *No description* | +| timeToLiveAttribute | str? | *No description* | + +

TransactWriteItem (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionCheck | TransactWriteItemConditionCheck? | *No description* | +| Delete | TransactWriteItemDelete? | *No description* | +| Put | TransactWriteItemPut? | *No description* | +| Update | TransactWriteItemUpdate? | *No description* | + +

TransactWriteItemConditionCheck (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Key | Json | *No description* | +| ReturnValuesOnConditionCheckFailure | bool? | *No description* | + +

TransactWriteItemDelete (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Key | Json | *No description* | +| ReturnValuesOnConditionCheckFailure | bool? | *No description* | + +

TransactWriteItemPut (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Item | Json | *No description* | +| ReturnValuesOnConditionCheckFailure | bool? | *No description* | + +

TransactWriteItemUpdate (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Key | Json | *No description* | +| ReturnValuesOnConditionCheckFailure | bool? | *No description* | +| UpdateExpression | str? | *No description* | + +

TransactWriteOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| TransactItems | Array | *No description* | + +

TransactWriteOutput (struct)

+ +

Properties

+ +*No properties* + +

UpdateOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Key | Json | *No description* | +| ReturnConsumedCapacity | str? | *No description* | +| ReturnValues | str? | *No description* | +| UpdateExpression | str | *No description* | + +

UpdateOutput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ConditionExpression | str? | *No description* | +| ExpressionAttributeNames | Map? | *No description* | +| ExpressionAttributeValues | Map? | *No description* | +| Item | Json | *No description* | +| ReturnValues | str? | *No description* | + +

ClientProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| credentials | Credentials? | *No description* | +| endpoint | str? | *No description* | +| region | str? | *No description* | +| tableName | str | *No description* | + diff --git a/dynamodb/package-lock.json b/dynamodb/package-lock.json index ef8bc0b5..229c8a2e 100644 --- a/dynamodb/package-lock.json +++ b/dynamodb/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/dynamodb", - "version": "0.2.1", + "version": "0.2.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/dynamodb", - "version": "0.2.1", + "version": "0.2.2", "license": "MIT", "peerDependencies": { "@aws-sdk/client-dynamodb": "^3.461.0", diff --git a/dynamodb/package.json b/dynamodb/package.json index ca3fd90a..a2ad36d0 100644 --- a/dynamodb/package.json +++ b/dynamodb/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/dynamodb", - "version": "0.2.1", + "version": "0.2.2", "description": "DynamoDB library for Wing", "author": { "name": "Cristian Pallarés", diff --git a/eventbridge/API.md b/eventbridge/API.md new file mode 100644 index 00000000..57981a1a --- /dev/null +++ b/eventbridge/API.md @@ -0,0 +1,212 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Bus + - platform.tfaws.Bus + - platform.sim.Bus + - platform.sim.EventBridgeBus + - platform.awscdk.Bus + - platform.aws.Util +- **Interfaces** + - IBus +- **Structs** + - BusProps + - Event + - PublishEvent + - platform.aws.PutEventCommandEntry + - platform.aws.PutEventCommandInput + +

Bus (preflight class)

+ +

Constructor

+ +
+new(props: BusProps?): Bus
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onEvent(name: str, handler: inflight (Event): void, pattern: Json): void | *No description* | +| inflight putEvents(events: Array): void | *No description* | +| subscribeQueue(name: str, queue: Queue, pattern: Json): void | *No description* | + +

platform.tfaws.Bus (preflight class)

+ +

Constructor

+ +
+new(props: BusProps?): Bus
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onEvent(name: str, handler: inflight (Event): void, pattern: Json): void | *No description* | +| inflight putEvents(events: Array): void | *No description* | +| subscribeQueue(name: str, queue: Queue, pattern: Json): void | *No description* | + +

platform.sim.Bus (preflight class)

+ +

Constructor

+ +
+new(props: BusProps?): Bus
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onEvent(name: str, handler: inflight (Event): void, pattern: Json): void | *No description* | +| inflight putEvents(events: Array): void | *No description* | +| subscribeQueue(name: str, queue: Queue, pattern: Json): void | *No description* | + +

platform.sim.EventBridgeBus (preflight class)

+ +

Constructor

+ +
+new(props: BusProps?): EventBridgeBus
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight putEvents(events: Array): void | *No description* | +| subscribe(callback: inflight (Event): void, pattern: Json): Resource | *No description* | + +

platform.awscdk.Bus (preflight class)

+ +

Constructor

+ +
+new(props: BusProps?): Bus
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static addRulePermission(handler: str, arn: str): void | *No description* | +| onEvent(name: str, handler: inflight (Event): void, pattern: Json): void | *No description* | +| inflight putEvents(events: Array): void | *No description* | +| subscribeQueue(name: str, queue: Queue, pattern: Json): void | *No description* | + +

platform.aws.Util (preflight class)

+ +

Constructor

+ +
+new(): Util
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static inflight _putEvent(name: str, event: PutEventCommandInput): void | *No description* | +| static inflight putEvent(name: str, events: Array): void | *No description* | + +

IBus (interface)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | Node | The tree node. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onEvent(name: str, handler: inflight (Event): void, pattern: Json): void | *No description* | +| inflight putEvents(events: Array): void | *No description* | +| subscribeQueue(name: str, queue: Queue, pattern: Json): void | *No description* | + +

BusProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| debug | bool? | *No description* | +| name | str | *No description* | + +

Event (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| account | str | *No description* | +| detail | Json | *No description* | +| detailType | str | *No description* | +| id | str | *No description* | +| region | str | *No description* | +| resources | Array | *No description* | +| source | str | *No description* | +| time | str | *No description* | +| version | str | *No description* | + +

PublishEvent (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| detail | Json | *No description* | +| detailType | str | *No description* | +| resources | Array | *No description* | +| source | str | *No description* | +| version | str | *No description* | + +

platform.aws.PutEventCommandEntry (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Detail | str | *No description* | +| DetailType | str | *No description* | +| EventBusName | str | *No description* | +| Resources | Array | *No description* | +| Source | str | *No description* | + +

platform.aws.PutEventCommandInput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Entries | Array | *No description* | + diff --git a/eventbridge/package-lock.json b/eventbridge/package-lock.json index 25bcb925..c35080f1 100644 --- a/eventbridge/package-lock.json +++ b/eventbridge/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/eventbridge", - "version": "0.1.6", + "version": "0.1.7", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/eventbridge", - "version": "0.1.6", + "version": "0.1.7", "license": "MIT", "peerDependencies": { "@aws-sdk/client-eventbridge": "^3.525.0", diff --git a/eventbridge/package.json b/eventbridge/package.json index 743209fe..87e036a5 100644 --- a/eventbridge/package.json +++ b/eventbridge/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/eventbridge", "description": "Amazon EventBridge library for Wing", - "version": "0.1.6", + "version": "0.1.7", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/fifoqueue/API.md b/fifoqueue/API.md new file mode 100644 index 00000000..400fc57c --- /dev/null +++ b/fifoqueue/API.md @@ -0,0 +1,116 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - FifoQueue + - FifoQueue_sim + - FifoQueue_aws +- **Interfaces** + - IFifoQueue +- **Structs** + - FifoQueueProps + - PushOptions + - SetConsumerOptions + +

FifoQueue (preflight class)

+ +

Constructor

+ +
+new(props: FifoQueueProps?): FifoQueue
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight push(message: str, options: PushOptions): void | *No description* | +| setConsumer(fn: inflight (str): void, options: SetConsumerOptions?): void | *No description* | + +

FifoQueue_sim (preflight class)

+ +

Constructor

+ +
+new(): FifoQueue_sim
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight push(message: str, options: PushOptions): void | *No description* | +| setConsumer(handler: inflight (str): void, options: SetConsumerOptions?): void | *No description* | + +

FifoQueue_aws (preflight class)

+ +

Constructor

+ +
+new(props: FifoQueueProps?): FifoQueue_aws
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight push(message: str, options: PushOptions): void | *No description* | +| setConsumer(handler: inflight (str): void, options: SetConsumerOptions?): void | *No description* | + +

IFifoQueue (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight push(message: str, options: PushOptions): void | *No description* | +| setConsumer(handler: inflight (str): void, options: SetConsumerOptions?): void | *No description* | + +

FifoQueueProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| dlq | DeadLetterQueueProps? | A dead-letter queue. | +| retentionPeriod | duration? | How long a queue retains a message. | +| timeout | duration? | How long a queue's consumers have to process a message. | + +

PushOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| groupId | str | *No description* | + +

SetConsumerOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| batchSize | num? | The maximum number of messages to send to subscribers at once. | +| concurrency | num? | The maximum concurrent invocations that can run at one time. | +| env | Map? | Environment variables to pass to the function. | +| logRetentionDays | num? | Specifies the number of days that function logs will be kept. | +| memory | num? | The amount of memory to allocate to the function, in MB. | +| timeout | duration? | The maximum amount of time the function can run. | + diff --git a/fifoqueue/package-lock.json b/fifoqueue/package-lock.json index 9e2a927e..d4ab6759 100644 --- a/fifoqueue/package-lock.json +++ b/fifoqueue/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/fifoqueue", - "version": "0.0.10", + "version": "0.0.11", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/fifoqueue", - "version": "0.0.10", + "version": "0.0.11", "license": "MIT", "peerDependencies": { "@aws-sdk/client-sqs": "^3.460.0", diff --git a/fifoqueue/package.json b/fifoqueue/package.json index d5ba855d..eaa1486a 100644 --- a/fifoqueue/package.json +++ b/fifoqueue/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/fifoqueue", - "version": "0.0.10", + "version": "0.0.11", "description": "A wing library to work with FIFO (first-in first-out) Queues", "author": { "name": "Elad Cohen", diff --git a/gen-docs-all.sh b/gen-docs-all.sh new file mode 100755 index 00000000..a063576b --- /dev/null +++ b/gen-docs-all.sh @@ -0,0 +1,32 @@ +#!/bin/bash +set -euo pipefail + +WING=${WING:-wing} + +# Read the skipped packages from the JSON file +skipped_packages=$(jq -r '.["skipped-packages"][].name' SKIPPED_LIBRARIES.json) + +# Loop through all packages +for package in */; do + package_name="${package%/}" + + if [ ! -f "$package_name/package.json" ]; then + continue + fi + + echo "-----------------------------------------------------------------------------" + echo $package_name + echo "-----------------------------------------------------------------------------" + + # Check if the package should be skipped + if echo "$skipped_packages" | grep -q "^$package_name$"; then + echo "Skipping $package_name" + continue + fi + + ( + cd $package + npm i + $WING gen-docs + ) +done diff --git a/github/API.md b/github/API.md new file mode 100644 index 00000000..8fc09cb9 --- /dev/null +++ b/github/API.md @@ -0,0 +1,484 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - ProbotApp + - utils.LowkeysMap + - simutils.Port + - simutils.Service + - probot.ProbotAdapter + - ngrok.Ngrok +- **Interfaces** + - IProbotAppCredentialsSupplier + - simutils.Process + - probot.IProbotAuth + - probot.IProbotWebhooks + - probot.IProbotAppCredentialsSupplier +- **Structs** + - ProbotAppProps + - simutils.ServiceProps + - probot.Context + - probot.ProbotInstance + - probot.PullRequestClosedContext + - probot.PullRequestContext + - probot.PullRequestOpenedContext + - probot.PullRequestSyncContext + - probot.PushContext + - probot.VerifyAndReceieveProps + - probot.CreateAdapterOptions + - probot.ProbotAdapterProps + - octokit.CompareCommitsProps + - octokit.CompareCommitsResponse + - octokit.CompareCommitsResponseCommit + - octokit.CompareCommitsResponseData + - octokit.CompareCommitsResponseFile + - octokit.GetCommitProps + - octokit.GetCommitResponse + - octokit.GetCommitResponseData + - octokit.GetCommitResponseFile + - octokit.GetContentProps + - octokit.GetContentResponse + - octokit.GetContentResponseData + - octokit.ListReposResponse + - octokit.OctoKit + - ngrok.NgrokProps + +

ProbotApp (preflight class)

+ +

Constructor

+ +
+new(props: ProbotAppProps): ProbotApp
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static inflight createGithubAppJwt(appId: str, privateKey: str): str | *No description* | +| onPullRequestOpened(handler: inflight (PullRequestOpenedContext): void): void | *No description* | +| onPullRequestReopened(handler: inflight (PullRequestOpenedContext): void): void | *No description* | +| inflight updateWebhookUrl(url: str): void | *No description* | + +

utils.LowkeysMap (inflight class)

+ +

Constructor

+ +
+new(): LowkeysMap
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static inflight fromMap(map: Map): Map | *No description* | + +

simutils.Port (preflight class)

+ +

Constructor

+ +
+new(): Port
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| port | str | *No description* | + +

Methods

+ +*No methods* + +

simutils.Service (preflight class)

+ +

Constructor

+ +
+new(command: str, args: Array, props: ServiceProps): Service
+
+ +

Properties

+ +*No properties* + +

Methods

+ +*No methods* + +

probot.ProbotAdapter (preflight class)

+ +

Constructor

+ +
+new(props: ProbotAdapterProps): ProbotAdapter
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight auth(installationId: num): OctoKit | *No description* | +| static inflight createProbotAdapter(options: CreateAdapterOptions): ProbotInstance | *No description* | +| inflight handlePullRequstClosed(handler: inflight (PullRequestClosedContext): void): void | *No description* | +| inflight handlePullRequstOpened(handler: inflight (PullRequestOpenedContext): void): void | *No description* | +| inflight handlePullRequstReopened(handler: inflight (PullRequestOpenedContext): void): void | *No description* | +| inflight handlePullRequstSync(handler: inflight (PullRequestSyncContext): void): void | *No description* | +| inflight handlePush(handler: inflight (PushContext): void): void | *No description* | +| inflight verifyAndReceive(props: VerifyAndReceieveProps): void | *No description* | + +

ngrok.Ngrok (preflight class)

+ +

Constructor

+ +
+new(props: NgrokProps): Ngrok
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +*No methods* + +

IProbotAppCredentialsSupplier (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight getId(): str | *No description* | +| inflight getPrivateKey(): str | *No description* | +| inflight getWebhookSecret(): str | *No description* | + +

simutils.Process (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight kill(): void | *No description* | + +

probot.IProbotAuth (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight call(instance: ProbotInstance, installationId: num): OctoKit | *No description* | + +

probot.IProbotWebhooks (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight on(name: str, handler: inflight (): void): void | *No description* | +| inflight verifyAndReceive(props: VerifyAndReceieveProps): void | *No description* | + +

probot.IProbotAppCredentialsSupplier (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight getId(): str | *No description* | +| inflight getPrivateKey(): str | *No description* | +| inflight getWebhookSecret(): str | *No description* | + +

ProbotAppProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| credentialsSupplier | IProbotAppCredentialsSupplier | *No description* | + +

simutils.ServiceProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| cwd | str? | *No description* | +| env | Map? | *No description* | + +

probot.Context (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | *No description* | +| octokit | OctoKit | *No description* | + +

probot.ProbotInstance (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| auth | IProbotAuth | *No description* | +| webhooks | IProbotWebhooks | *No description* | + +

probot.PullRequestClosedContext (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | *No description* | +| octokit | OctoKit | *No description* | +| payload | PullRequestPayload | *No description* | + +

probot.PullRequestContext (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | *No description* | +| octokit | OctoKit | *No description* | +| payload | PullRequestPayload | *No description* | + +

probot.PullRequestOpenedContext (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | *No description* | +| octokit | OctoKit | *No description* | +| payload | PullRequestPayload | *No description* | + +

probot.PullRequestSyncContext (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | *No description* | +| octokit | OctoKit | *No description* | +| payload | PullRequestPayload | *No description* | + +

probot.PushContext (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | *No description* | +| octokit | OctoKit | *No description* | +| payload | PushPayload | *No description* | + +

probot.VerifyAndReceieveProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | *No description* | +| name | str | *No description* | +| payload | str | *No description* | +| signature | str | *No description* | + +

probot.CreateAdapterOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| appId | str | *No description* | +| privateKey | str | *No description* | +| webhookSecret | str | *No description* | + +

probot.ProbotAdapterProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| credentialsSupplier | IProbotAppCredentialsSupplier | *No description* | + +

octokit.CompareCommitsProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| base | str | *No description* | +| head | str | *No description* | +| owner | str | *No description* | +| repo | str | *No description* | + +

octokit.CompareCommitsResponse (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| data | CompareCommitsResponseData | *No description* | + +

octokit.CompareCommitsResponseCommit (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| sha | str | *No description* | + +

octokit.CompareCommitsResponseData (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| commits | Array | *No description* | + +

octokit.CompareCommitsResponseFile (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| filaname | str | *No description* | +| sha | str | *No description* | + +

octokit.GetCommitProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| owner | str | *No description* | +| ref | str | *No description* | +| repo | str | *No description* | + +

octokit.GetCommitResponse (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| data | GetCommitResponseData | *No description* | + +

octokit.GetCommitResponseData (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| files | Array? | *No description* | + +

octokit.GetCommitResponseFile (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| filename | str | *No description* | +| sha | str | *No description* | +| status | str | *No description* | + +

octokit.GetContentProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| owner | str | *No description* | +| path | str | *No description* | +| ref | str? | *No description* | +| repo | str | *No description* | + +

octokit.GetContentResponse (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| data | GetContentResponseData | *No description* | +| status | num | *No description* | + +

octokit.GetContentResponseData (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| content | str? | *No description* | +| name | str | *No description* | +| path | str | *No description* | +| sha | str | *No description* | +| size | num | *No description* | +| type | str | *No description* | + +

octokit.ListReposResponse (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| data | Array | *No description* | +| status | num | *No description* | + +

octokit.OctoKit (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apps | OctoKitApps | *No description* | +| git | OctoKitGit | *No description* | +| issues | OctoKitIssues | *No description* | +| pulls | OctoKitPulls | *No description* | +| repos | OctoKitRepos | *No description* | + +

ngrok.NgrokProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| domain | str? | *No description* | +| url | str | *No description* | + diff --git a/github/package-lock.json b/github/package-lock.json index 818823e6..d7846e1d 100644 --- a/github/package-lock.json +++ b/github/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/github", - "version": "0.0.14", + "version": "0.0.15", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/github", - "version": "0.0.14", + "version": "0.0.15", "license": "MIT", "peerDependencies": { "@probot/adapter-aws-lambda-serverless": "^3.0.4", diff --git a/github/package.json b/github/package.json index 5ed36edc..6066f86f 100644 --- a/github/package.json +++ b/github/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/github", "description": "A Wing library for GitHub Probot", - "version": "0.0.14", + "version": "0.0.15", "author": { "name": "Elad Cohen", "email": "eladc@wing.cloud" diff --git a/jwt/API.md b/jwt/API.md new file mode 100644 index 00000000..49ad7d1d --- /dev/null +++ b/jwt/API.md @@ -0,0 +1,82 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Util +- **Structs** + - DecodeOptions + - SignOptions + - VerifyJwtOptions + - VerifyOptions + +

Util (preflight class)

+ +

Constructor

+ +
+new(): Util
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static inflight decode(token: str, options: DecodeOptions?): Json | *No description* | +| static inflight sign(data: Json, secret: str, options: SignOptions?): str | *No description* | +| static inflight verify(token: str, options: VerifyOptions): Json | *No description* | + +

DecodeOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| complete | bool? | *No description* | + +

SignOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| algorithm | str? | *No description* | +| audience | Array? | *No description* | +| encoding | str? | *No description* | +| expiresIn | duration? | *No description* | +| issuer | str? | *No description* | +| jwtid | str? | *No description* | +| keyid | str? | *No description* | +| notBefore | duration? | *No description* | +| subject | str? | *No description* | + +

VerifyJwtOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| algorithms | Array? | *No description* | +| audience | str? | *No description* | +| ignoreExpiration | bool? | *No description* | +| ignoreNotBefore | bool? | *No description* | +| issuer | str? | *No description* | +| jwtid | str? | *No description* | +| maxAge | str? | *No description* | +| nonce | str? | *No description* | +| subject | str? | *No description* | + +

VerifyOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| jwksUri | str? | *No description* | +| options | VerifyJwtOptions? | *No description* | +| secret | str? | *No description* | + diff --git a/jwt/package-lock.json b/jwt/package-lock.json index c0cfa23e..d9f3a1cd 100644 --- a/jwt/package-lock.json +++ b/jwt/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/jwt", - "version": "0.0.7", + "version": "0.0.8", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/jwt", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "peerDependencies": { "jsonwebtoken": "^9.0.2", diff --git a/jwt/package.json b/jwt/package.json index 38b3182a..fa3cd8a1 100644 --- a/jwt/package.json +++ b/jwt/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/jwt", "description": "Wing library for JWT authentication", - "version": "0.0.7", + "version": "0.0.8", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/k8s/API.md b/k8s/API.md new file mode 100644 index 00000000..cddf39c6 --- /dev/null +++ b/k8s/API.md @@ -0,0 +1,49 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - ApiObject +- **Structs** + - ApiObjectProps + +

ApiObject (preflight class)

+ +

Constructor

+ +
+new(props: ApiObjectProps): ApiObject
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | str | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | str | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | Chart | The chart in which this object is defined. | +| kind | str | The object kind. | +| metadata | ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | str | The name of the API object. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addDependency(dependencies: Array): void | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch(ops: Array): void | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| static isApiObject(o: any): bool | Return whether the given object is an `ApiObject`. | +| static of(c: IConstruct): ApiObject | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| toJson(): any | Renders the object to Kubernetes JSON. | + +

ApiObjectProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiVersion | str | API version. | +| kind | str | Resource kind. | +| metadata | ApiObjectMetadata? | Object metadata. | +| spec | Json? | *No description* | + diff --git a/k8s/package-lock.json b/k8s/package-lock.json index 81c0028d..0f2065ac 100644 --- a/k8s/package-lock.json +++ b/k8s/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/k8s", - "version": "0.0.7", + "version": "0.0.9", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/k8s", - "version": "0.0.7", + "version": "0.0.9", "license": "MIT", "devDependencies": { "cdk8s-plus-27": "^2.9.0" diff --git a/k8s/package.json b/k8s/package.json index c7865732..d448f1dd 100644 --- a/k8s/package.json +++ b/k8s/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/k8s", "description": "Wing for Kubernetes", - "version": "0.0.8", + "version": "0.0.9", "author": { "name": "Elad Ben-Israel", "email": "eladb@wing.cloud" diff --git a/lock/API.md b/lock/API.md new file mode 100644 index 00000000..6d889922 --- /dev/null +++ b/lock/API.md @@ -0,0 +1,39 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Lock +- **Structs** + - LockAcquireOptions + +

Lock (preflight class)

+ +

Constructor

+ +
+new(): Lock
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight acquire(id: str, options: LockAcquireOptions): void | *No description* | +| inflight release(id: str): void | *No description* | +| inflight tryAcquire(id: str, options: LockAcquireOptions): bool | *No description* | +| inflight tryRelease(id: str): bool | *No description* | + +

LockAcquireOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| expiry | duration? | *No description* | +| timeout | duration | *No description* | + diff --git a/lock/package-lock.json b/lock/package-lock.json index 59d3c6cd..69c8919b 100644 --- a/lock/package-lock.json +++ b/lock/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/lock", - "version": "0.0.6", + "version": "0.0.7", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/lock", - "version": "0.0.6", + "version": "0.0.7", "license": "MIT" } } diff --git a/lock/package.json b/lock/package.json index 1dd98d94..ffa918ec 100644 --- a/lock/package.json +++ b/lock/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/lock", "description": "A Wing library for cloud Lock", - "version": "0.0.6", + "version": "0.0.7", "author": { "name": "Eyal Keren", "email": "eyalk@wing.cloud" diff --git a/messagefanout/API.md b/messagefanout/API.md new file mode 100644 index 00000000..c92c76e3 --- /dev/null +++ b/messagefanout/API.md @@ -0,0 +1,96 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - MessageFanout + - platform.MessageFanout_tfaws + - platform.MessageFanout_sim +- **Interfaces** + - commons.IMessageFanout +- **Structs** + - commons.MessageFanoutProps + +

MessageFanout (preflight class)

+ +

Constructor

+ +
+new(): MessageFanout
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void | *No description* | +| inflight publish(message: str): void | *No description* | + +

platform.MessageFanout_tfaws (preflight class)

+ +

Constructor

+ +
+new(): MessageFanout_tfaws
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void | *No description* | +| inflight publish(message: str): void | *No description* | + +

platform.MessageFanout_sim (preflight class)

+ +

Constructor

+ +
+new(): MessageFanout_sim
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void | *No description* | +| inflight publish(message: str): void | *No description* | + +

commons.IMessageFanout (interface)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | Node | The tree node. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void | *No description* | +| inflight publish(message: str): void | *No description* | + +

commons.MessageFanoutProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| dlq | DeadLetterQueueProps? | A dead-letter queue. | +| name | str | *No description* | +| retentionPeriod | duration? | How long a queue retains a message. | +| timeout | duration? | How long a queue's consumers have to process a message. | + diff --git a/messagefanout/package-lock.json b/messagefanout/package-lock.json index e0b2b10e..3f70c7bf 100644 --- a/messagefanout/package-lock.json +++ b/messagefanout/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/messagefanout", - "version": "0.0.7", + "version": "0.0.8", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/messagefanout", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "peerDependencies": { "@aws-sdk/client-sns": "^3.511.0", diff --git a/messagefanout/package.json b/messagefanout/package.json index b1493a9d..acc2e611 100644 --- a/messagefanout/package.json +++ b/messagefanout/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/messagefanout", "description": "Message fanout library for Wing", - "version": "0.0.7", + "version": "0.0.8", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/momento/API.md b/momento/API.md new file mode 100644 index 00000000..39642da9 --- /dev/null +++ b/momento/API.md @@ -0,0 +1,69 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Cache +- **Interfaces** + - ICache +- **Structs** + - CacheGetOptions + - CacheProps + - CacheSetOptions + +

Cache (preflight class)

+ +

Constructor

+ +
+new(props: CacheProps): Cache
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight get(key: str): str? | *No description* | +| inflight set(key: str, value: str, opts: CacheSetOptions?): void | *No description* | + +

ICache (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight get(key: str, opts: CacheGetOptions?): str? | Get a value from the cache. | +| inflight set(key: str, value: str, opts: CacheSetOptions?): void | Set a value in the cache. | + +

CacheGetOptions (struct)

+ +

Properties

+ +*No properties* + +

CacheProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| defaultTtl | duration? | The default time-to-live for cache entries. @default 60 | +| name | str? | The name of the cache. @default - a unique id will be generated | +| token | Secret | A secret containing the Momento API key to use for accessing the cache at runtime. | + +

CacheSetOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ttl | duration? | The time-to-live for the cache entry, in seconds. @default 60s | + diff --git a/momento/package-lock.json b/momento/package-lock.json index f9302d7d..df83b697 100644 --- a/momento/package-lock.json +++ b/momento/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/momento", - "version": "0.0.4", + "version": "0.0.5", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/momento", - "version": "0.0.4", + "version": "0.0.5", "license": "MIT", "peerDependencies": { "@gomomento/sdk": "^1.93.0", diff --git a/momento/package.json b/momento/package.json index 8d08bada..aba3fa87 100644 --- a/momento/package.json +++ b/momento/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/momento", "description": "momento library for Wing", - "version": "0.0.4", + "version": "0.0.5", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/ngrok/API.md b/ngrok/API.md new file mode 100644 index 00000000..0d4b478a --- /dev/null +++ b/ngrok/API.md @@ -0,0 +1,52 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Tunnel +- **Interfaces** + - OnConnectHandler +- **Structs** + - NgrokProps + +

Tunnel (preflight class)

+ +

Constructor

+ +
+new(url: str, props: NgrokProps?): Tunnel
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onConnect(handler: inflight (str): void): void | *No description* | + +

OnConnectHandler (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight handle(url: str): void | *No description* | + +

NgrokProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| domain | str? | *No description* | +| onConnect | (inflight (str): void)? | *No description* | + diff --git a/ngrok/package-lock.json b/ngrok/package-lock.json index e1d11825..646b37a0 100644 --- a/ngrok/package-lock.json +++ b/ngrok/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/ngrok", - "version": "0.0.9", + "version": "0.0.10", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/ngrok", - "version": "0.0.9", + "version": "0.0.10", "license": "MIT", "peerDependencies": { "@ngrok/ngrok": "^0.9.1" diff --git a/ngrok/package.json b/ngrok/package.json index c4003196..49bc93fa 100644 --- a/ngrok/package.json +++ b/ngrok/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/ngrok", - "version": "0.0.9", + "version": "0.0.10", "description": "ngrok library for Wing", "author": { "name": "Elad Ben-Israel", diff --git a/openai/API.md b/openai/API.md new file mode 100644 index 00000000..2052c74c --- /dev/null +++ b/openai/API.md @@ -0,0 +1,49 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - OpenAI +- **Structs** + - CompletionParams + - OpenAIProps + +

OpenAI (preflight class)

+ +

Constructor

+ +
+new(props: OpenAIProps?): OpenAI
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight createCompletion(prompt: str, params: CompletionParams?): str | *No description* | +| static inflight createNewInflightClient(apiKey: str, org: str?): IClient | *No description* | + +

CompletionParams (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxTokens | num? | *No description* | +| model | str? | *No description* | + +

OpenAIProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiKey | str? | *No description* | +| apiKeySecret | Secret? | *No description* | +| org | str? | *No description* | +| orgSecret | Secret? | *No description* | + diff --git a/openai/package-lock.json b/openai/package-lock.json index a163d11e..e9661ae9 100644 --- a/openai/package-lock.json +++ b/openai/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/openai", - "version": "0.0.7", + "version": "0.0.8", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/openai", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "peerDependencies": { "openai": "^4.28.4" diff --git a/openai/package.json b/openai/package.json index 69d33f24..acdeac6c 100644 --- a/openai/package.json +++ b/openai/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/openai", "description": "OpenAI library for Wing", - "version": "0.0.7", + "version": "0.0.8", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/postgres/API.md b/postgres/API.md new file mode 100644 index 00000000..75114be9 --- /dev/null +++ b/postgres/API.md @@ -0,0 +1,96 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Database + - DatabaseRef +- **Interfaces** + - IDatabase +- **Structs** + - AwsParameters + - ConnectionOptions + - DatabaseProps + +

Database (preflight class)

+ +

Constructor

+ +
+new(props: DatabaseProps): Database
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| connection | ConnectionOptions | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight connectionOptions(): ConnectionOptions | *No description* | +| inflight query(query: str): Array> | *No description* | + +

DatabaseRef (preflight class)

+ +

Constructor

+ +
+new(): DatabaseRef
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight query(query: str): Array> | *No description* | + +

IDatabase (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight connectionOptions(): ConnectionOptions? | *No description* | +| inflight query(query: str): Array> | *No description* | + +

AwsParameters (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| postgresEngine | str? | *No description* | + +

ConnectionOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| database | str | *No description* | +| host | str | *No description* | +| password | str | *No description* | +| port | str | *No description* | +| ssl | bool | *No description* | +| user | str | *No description* | + +

DatabaseProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | str | *No description* | +| pgVersion | num? | *No description* | + diff --git a/postgres/package-lock.json b/postgres/package-lock.json index 174cc302..e878f3c2 100644 --- a/postgres/package-lock.json +++ b/postgres/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/postgres", - "version": "0.1.11", + "version": "0.1.12", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/postgres", - "version": "0.1.11", + "version": "0.1.12", "license": "MIT", "peerDependencies": { "@cdktf/provider-aws": "^19.12.0", diff --git a/postgres/package.json b/postgres/package.json index ad261850..2dd23d50 100644 --- a/postgres/package.json +++ b/postgres/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/postgres", - "version": "0.1.11", + "version": "0.1.12", "description": "Postgres support for Wing", "repository": { "type": "git", diff --git a/react/API.md b/react/API.md new file mode 100644 index 00000000..82bcf5d5 --- /dev/null +++ b/react/API.md @@ -0,0 +1,141 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Utils + - AppTfAws + - AppSim + - App + - AppBase +- **Interfaces** + - IApp +- **Structs** + - AppProps + +

Utils (preflight class)

+ +

Constructor

+ +
+new(): Utils
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static inflight exec(command: str, env: MutMap, cwd: str): inflight (): void | *No description* | +| static execSync(command: str, env: MutMap, cwd: str): void | *No description* | +| static inflight serveStaticFiles(path: str, port: num): inflight (): void | *No description* | + +

AppTfAws (preflight class)

+ +

Constructor

+ +
+new(props: AppProps): AppTfAws
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| _preSynthesize(): void | *No description* | +| getUrl(): str | *No description* | +| addEnvironment(key: str, value: str): void | *No description* | + +

AppSim (preflight class)

+ +

Constructor

+ +
+new(props: AppProps): AppSim
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| getUrl(): str | *No description* | +| addEnvironment(key: str, value: str): void | *No description* | + +

App (preflight class)

+ +

Constructor

+ +
+new(props: AppProps): App
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addEnvironment(key: str, value: str): void | *No description* | + +

AppBase (preflight class)

+ +

Constructor

+ +
+new(props: AppProps): AppBase
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addEnvironment(key: str, value: str): void | *No description* | + +

IApp (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addEnvironment(key: str, value: str): void | *No description* | +| getUrl(): str | *No description* | + +

AppProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| buildCommand | str? | *No description* | +| buildDir | str? | *No description* | +| domain | Domain? | *No description* | +| localPort | num? | *No description* | +| projectPath | str | *No description* | +| startCommand | str? | *No description* | +| useBuildCommand | bool? | *No description* | + diff --git a/react/package-lock.json b/react/package-lock.json index 6de2e2e4..67c95c1c 100644 --- a/react/package-lock.json +++ b/react/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/react", - "version": "0.1.4", + "version": "0.1.5", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/react", - "version": "0.1.4", + "version": "0.1.5", "license": "MIT", "peerDependencies": { "finalhandler": "^1.2.0", diff --git a/react/package.json b/react/package.json index 6c27e2f5..184fd2f3 100644 --- a/react/package.json +++ b/react/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/react", "description": "React library for Wing", - "version": "0.1.4", + "version": "0.1.5", "author": { "name": "Meir Elbaz", "email": "maornet@gmail.com" diff --git a/redis/API.md b/redis/API.md new file mode 100644 index 00000000..e6d0c344 --- /dev/null +++ b/redis/API.md @@ -0,0 +1,120 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Util + - Redis + - Redis_sim +- **Interfaces** + - IRedis + - IRedisClient + +

Util (preflight class)

+ +

Constructor

+ +
+new(): Util
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static inflight newRedisClient(url: str, redisPassword: str): IRedisClient | *No description* | + +

Redis (preflight class)

+ +

Constructor

+ +
+new(): Redis
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight del(key: str): void? | *No description* | +| inflight get(key: str): str? | *No description* | +| inflight hGet(key: str, field: str): str? | *No description* | +| inflight hSet(key: str, field: str, value: str): void? | *No description* | +| inflight sAdd(key: str, value: str): void? | *No description* | +| inflight sMembers(key: str): Array? | *No description* | +| inflight set(key: str, value: str): void? | *No description* | +| inflight url(): str | *No description* | + +

Redis_sim (preflight class)

+ +

Constructor

+ +
+new(): Redis_sim
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight del(key: str): void | *No description* | +| inflight get(key: str): str? | *No description* | +| inflight hGet(key: str, field: str): str? | *No description* | +| inflight hSet(key: str, field: str, value: str): void | *No description* | +| inflight sAdd(key: str, value: str): void | *No description* | +| inflight sMembers(key: str): Array? | *No description* | +| inflight set(key: str, value: str): void | *No description* | +| inflight url(): str | *No description* | + +

IRedis (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight del(key: str): void | *No description* | +| inflight get(key: str): str? | *No description* | +| inflight hGet(key: str, field: str): str? | *No description* | +| inflight hSet(key: str, field: str, value: str): void | *No description* | +| inflight sAdd(key: str, value: str): void | *No description* | +| inflight sMembers(key: str): Array? | *No description* | +| inflight set(key: str, value: str): void | *No description* | +| inflight url(): str | *No description* | + +

IRedisClient (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight connect(): void | *No description* | +| inflight del(key: str): void | *No description* | +| inflight disconnect(): void | *No description* | +| inflight get(key: str): str? | *No description* | +| inflight hGet(key: str, field: str): str? | *No description* | +| inflight hSet(key: str, field: str, value: str): void | *No description* | +| inflight sAdd(key: str, value: str): void | *No description* | +| inflight sMembers(key: str): Array? | *No description* | +| inflight set(key: str, value: str): void | *No description* | +| inflight url(): str | *No description* | + diff --git a/redis/package-lock.json b/redis/package-lock.json index 8ebb72d7..64ff9187 100644 --- a/redis/package-lock.json +++ b/redis/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/redis", - "version": "0.0.11", + "version": "0.0.12", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/redis", - "version": "0.0.11", + "version": "0.0.12", "license": "MIT", "peerDependencies": { "@winglibs/containers": "^0.1.2", diff --git a/redis/package.json b/redis/package.json index e64b3ce2..a27c04a5 100644 --- a/redis/package.json +++ b/redis/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/redis", - "version": "0.0.11", + "version": "0.0.12", "description": "Redis resource for Wing", "repository": { "type": "git", diff --git a/sagemaker/API.md b/sagemaker/API.md new file mode 100644 index 00000000..6734d9c8 --- /dev/null +++ b/sagemaker/API.md @@ -0,0 +1,113 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Endpoint + - SageMaker_tfaws + - SageMaker_sim +- **Interfaces** + - ISageMaker +- **Structs** + - InvocationOptions + - InvocationOutput + +

Endpoint (preflight class)

+ +

Constructor

+ +
+new(endpointName: str, inferenceComponentName: str): Endpoint
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| endpointName | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight invoke(body: Json, options: InvocationOptions?): InvocationOutput | *No description* | + +

SageMaker_tfaws (preflight class)

+ +

Constructor

+ +
+new(endpointName: str, inferenceComponentName: str): SageMaker_tfaws
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| endpointName | str | *No description* | +| inferenceComponentName | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight invoke(body: Json, options: InvocationOptions?): InvocationOutput | *No description* | + +

SageMaker_sim (preflight class)

+ +

Constructor

+ +
+new(endpointName: str, inferenceName: str): SageMaker_sim
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight invoke(body: Json, options: InvocationOptions?): InvocationOutput | *No description* | +| setMockResponse(fn: inflight (Json, InvocationOptions?): InvocationOutput): void | *No description* | + +

ISageMaker (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight invoke(body: Json, InvocationOptions: InvocationOptions?): InvocationOutput | *No description* | + +

InvocationOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Accept | str? | *No description* | +| ContentType | str? | *No description* | +| CustomAttributes | str? | *No description* | +| EnableExplanations | str? | *No description* | +| InferenceComponentName | str? | *No description* | +| InferenceId | str? | *No description* | +| TargetContainerHostname | str? | *No description* | +| TargetModel | str? | *No description* | +| TargetVariant | str? | *No description* | + +

InvocationOutput (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Body | str | *No description* | +| ContentType | str? | *No description* | +| CustomAttributes | str? | *No description* | +| InvokedProductionVariant | str? | *No description* | + diff --git a/sagemaker/package-lock.json b/sagemaker/package-lock.json index 0157fd29..e8581216 100644 --- a/sagemaker/package-lock.json +++ b/sagemaker/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/sagemaker", - "version": "0.0.8", + "version": "0.0.9", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/sagemaker", - "version": "0.0.8", + "version": "0.0.9", "license": "MIT", "peerDependencies": { "@aws-sdk/client-sagemaker-runtime": "^3.507.0" diff --git a/sagemaker/package.json b/sagemaker/package.json index 0c1eb5b8..cc92accd 100644 --- a/sagemaker/package.json +++ b/sagemaker/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/sagemaker", - "version": "0.0.8", + "version": "0.0.9", "description": "The library enables owners of a trained sagemaker model, to access its Endpoints from a winglang inflight code.", "repository": { "type": "git", diff --git a/ses/API.md b/ses/API.md new file mode 100644 index 00000000..1c140ac7 --- /dev/null +++ b/ses/API.md @@ -0,0 +1,201 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - EmailService_tfaws + - EmailService_sim + - EmailService +- **Interfaces** + - IEmailService +- **Structs** + - Body + - CloudWatchDestination + - ConfigurationSet + - Content + - Destination + - EmailServiceProps + - EventDestination + - Message + - RawMessage + - SendEmailOptions + - SendRawEmailOptions + +

EmailService_tfaws (preflight class)

+ +

Constructor

+ +
+new(props: EmailServiceProps): EmailService_tfaws
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight sendEmail(options: SendEmailOptions): str? | *No description* | +| inflight sendRawEmail(options: SendRawEmailOptions): str? | *No description* | + +

EmailService_sim (preflight class)

+ +

Constructor

+ +
+new(props: EmailServiceProps): EmailService_sim
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight sendEmail(options: SendEmailOptions): str? | *No description* | +| inflight sendRawEmail(options: SendRawEmailOptions): str? | *No description* | + +

EmailService (preflight class)

+ +EmailService can used for defining and interacting with AWS SES. +When running the simulator in a non test environment, it will use the +actual cloud implementation. + +

Constructor

+ +
+new(props: EmailServiceProps): EmailService
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight sendEmail(options: SendEmailOptions): str? | *No description* | +| inflight sendRawEmail(options: SendRawEmailOptions): str? | *No description* | + +

IEmailService (interface)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | Node | The tree node. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight sendEmail(options: SendEmailOptions): str? | *No description* | +| inflight sendRawEmail(options: SendRawEmailOptions): str? | *No description* | + +

Body (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Html | Content? | *No description* | +| Text | Content? | *No description* | + +

CloudWatchDestination (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| defaultValue | str | *No description* | +| dimensionName | str | *No description* | +| valueSource | str | *No description* | + +

ConfigurationSet (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | str | *No description* | + +

Content (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Data | str? | *No description* | + +

Destination (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| BccAddresses | Array? | *No description* | +| CcAddresses | Array? | *No description* | +| ToAddresses | Array? | *No description* | + +

EmailServiceProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| configurationSet | ConfigurationSet? | *No description* | +| emailIdentities | Array? | *No description* | +| eventDestination | EventDestination? | *No description* | + +

EventDestination (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| cloudwatchDestination | CloudWatchDestination? | *No description* | +| matchingTypes | Array | *No description* | +| name | str | *No description* | + +

Message (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Body | Body? | *No description* | +| Subject | Content? | *No description* | + +

RawMessage (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Data | str | *No description* | + +

SendEmailOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Destination | Destination? | *No description* | +| Message | Message? | *No description* | +| Source | str | *No description* | + +

SendRawEmailOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Destinations | Array? | *No description* | +| RawMessage | RawMessage | *No description* | +| Source | str? | *No description* | + diff --git a/ses/package-lock.json b/ses/package-lock.json index 74c5588f..41493e13 100644 --- a/ses/package-lock.json +++ b/ses/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/ses", - "version": "0.0.6", + "version": "0.0.7", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/ses", - "version": "0.0.6", + "version": "0.0.7", "license": "MIT", "peerDependencies": { "@aws-sdk/client-ses": "^3.572.0", diff --git a/ses/package.json b/ses/package.json index 64b4fc62..63b997f4 100644 --- a/ses/package.json +++ b/ses/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/ses", "description": "Wing library for interacting with AWS SES", - "version": "0.0.6", + "version": "0.0.7", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/simtools/API.md b/simtools/API.md new file mode 100644 index 00000000..aa447f55 --- /dev/null +++ b/simtools/API.md @@ -0,0 +1,25 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Util + +

Util (preflight class)

+ +

Constructor

+ +
+new(): Util
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static addMacro(target: IResource, name: str, fn: inflight (): void): void | *No description* | + diff --git a/simtools/package-lock.json b/simtools/package-lock.json index 9fb49463..3fe76cb3 100644 --- a/simtools/package-lock.json +++ b/simtools/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/simtools", - "version": "0.0.4", + "version": "0.0.5", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/simtools", - "version": "0.0.4", + "version": "0.0.5", "license": "MIT" } } diff --git a/simtools/package.json b/simtools/package.json index a194bfd4..c90d5a41 100644 --- a/simtools/package.json +++ b/simtools/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/simtools", "description": "Wing simulator utility library", - "version": "0.0.4", + "version": "0.0.5", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/slack/API.md b/slack/API.md new file mode 100644 index 00000000..6de20f70 --- /dev/null +++ b/slack/API.md @@ -0,0 +1,320 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - SlackUtils + - Message + - App + - Channel + - EventContext + - EventContext_Mock + - MockChannel + - Thread +- **Interfaces** + - IThread +- **Structs** + - Block + - Field + - Section + - AppProps + - CallbackEvent + - MessageCallbackEvent + - SlackEvent + - VerificationEvent +- **Enums** + - BlockType + - FieldType + +

SlackUtils (preflight class)

+ +

Constructor

+ +
+new(): SlackUtils
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static inflight post(body: Json, token: str): Json | *No description* | + +

Message (inflight class)

+ +Represents a Message block see: https://api.slack.com/block-kit + +

Constructor

+ +
+new(): Message
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| sections | MutArray
| *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight addSection(section: Section): void | *No description* | +| inflight toJson(): Json | Returns Json representation of message | + +

App (preflight class)

+ +

Constructor

+ +
+new(props: AppProps): App
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| api | Api | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight channel(id: str): Channel | Retrieve a channel object from a channel Id or name | +| onEvent(eventName: str, handler: inflight (EventContext, Json): Json?): void | Register an event handler (for available events see: https://api.slack.com/events) | + +

Channel (inflight class)

+ +Represents the context of a slack channel + +

Constructor

+ +
+new(): Channel
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | The channel id | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight post(message: str): Json | Post raw text to a channel | +| inflight postMessage(message: Message): Json | Post a message block to a channel | + +

EventContext (inflight class)

+ +Represents the context of an event callback + +

Constructor

+ +
+new(): EventContext
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| channel | Channel | *No description* | +| thread | Thread | *No description* | + +

Methods

+ +*No methods* + +

EventContext_Mock (inflight class)

+ +Internally used for mocking event context + +

Constructor

+ +
+new(): EventContext_Mock
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| channel | Channel | *No description* | +| thread | Thread | *No description* | + +

Methods

+ +*No methods* + +

MockChannel (inflight class)

+ +Only used for internal testing + +

Constructor

+ +
+new(): MockChannel
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| id | str | The channel id | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight post(message: str): Json | *No description* | +| inflight postMessage(message: Message): Json | *No description* | + +

Thread (inflight class)

+ +Represents the context of a slack thread + +

Constructor

+ +
+new(): Thread
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| channel | Channel | The channel context | +| timestamp | str | The thread timestamp | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight post(message: str): Json | Post raw text to a thread | +| inflight postMessage(message: Message): Json | Post a message to a thread | + +

IThread (interface)

+ +The bahvioral interface of a thread + +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight post(message: str): Json | *No description* | +| inflight postMessage(message: Message): Json | *No description* | + +

Block (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fields | Array | *No description* | +| type | BlockType | *No description* | + +

Field (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| text | str | *No description* | +| type | FieldType | *No description* | + +

Section (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fields | Array | *No description* | + +

AppProps (struct)

+ +Properties for Slack bot + +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ignoreBots | bool? | Whether events from bot users should be ignored (default: true) | +| token | Secret | The token secret to use for the app | + +

CallbackEvent (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| app_id | str? | *No description* | +| bot_id | str? | *No description* | +| channel | str | *No description* | +| event_ts | str | *No description* | +| team | str? | *No description* | +| ts | str | *No description* | +| type | str | *No description* | +| user | str | *No description* | + +

MessageCallbackEvent (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| app_id | str? | *No description* | +| bot_id | str? | *No description* | +| channel | str | *No description* | +| event_ts | str | *No description* | +| team | str? | *No description* | +| text | str | *No description* | +| ts | str | *No description* | +| type | str | *No description* | +| user | str | *No description* | + +

SlackEvent (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | str | *No description* | + +

VerificationEvent (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| challenge | str | *No description* | +| token | str | *No description* | +| type | str | *No description* | + +

BlockType (enum)

+ +

Values

+ +| **Name** | **Description** | +| --- | --- | +| section | *No description* | + +

FieldType (enum)

+ +

Values

+ +| **Name** | **Description** | +| --- | --- | +| plain_text | *No description* | +| mrkdwn | *No description* | + diff --git a/slack/package-lock.json b/slack/package-lock.json index 672253e2..93a5cb7a 100644 --- a/slack/package-lock.json +++ b/slack/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/slack", - "version": "0.1.3", + "version": "0.1.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/slack", - "version": "0.1.3", + "version": "0.1.4", "license": "MIT", "peerDependencies": { "cdktf": "0.20.7" diff --git a/slack/package.json b/slack/package.json index 8b721d6a..6f3184aa 100644 --- a/slack/package.json +++ b/slack/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/slack", - "version": "0.1.3", + "version": "0.1.4", "description": "Slack library for Wing", "repository": { "type": "git", diff --git a/sns/API.md b/sns/API.md new file mode 100644 index 00000000..57018218 --- /dev/null +++ b/sns/API.md @@ -0,0 +1,118 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - MobileNotifications_sim + - MobileNotifications + - MobileNotifications_aws +- **Interfaces** + - IMobileNotifications +- **Structs** + - MessageAttributeValue + - PublishOptions + - PublishResult + +

MobileNotifications_sim (preflight class)

+ +

Constructor

+ +
+new(): MobileNotifications_sim
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight publish(options: PublishOptions): PublishResult | *No description* | + +

MobileNotifications (preflight class)

+ +MobileNotifications is a client for interacting with SNS mobile service. +No cloud resources are created when using this class. +When running the simulator in a non test environment, it will use the +actual cloud implementation. + +

Constructor

+ +
+new(): MobileNotifications
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight publish(options: PublishOptions): PublishResult | *No description* | + +

MobileNotifications_aws (preflight class)

+ +

Constructor

+ +
+new(): MobileNotifications_aws
+
+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight publish(options: PublishOptions): PublishResult | *No description* | + +

IMobileNotifications (interface)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | Node | The tree node. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| inflight publish(options: PublishOptions): PublishResult | *No description* | + +

MessageAttributeValue (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| DataType | str? | *No description* | +| StringValue | str? | *No description* | + +

PublishOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| Message | str? | *No description* | +| MessageAttributes | Map? | *No description* | +| PhoneNumber | str? | *No description* | +| Subject | str? | *No description* | +| TopicArn | str? | *No description* | + +

PublishResult (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| MessageId | str? | *No description* | +| SequenceNumber | str? | *No description* | + diff --git a/sns/package-lock.json b/sns/package-lock.json index e677e5f7..f3a351af 100644 --- a/sns/package-lock.json +++ b/sns/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/sns", - "version": "0.1.5", + "version": "0.1.6", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/sns", - "version": "0.1.5", + "version": "0.1.6", "license": "MIT", "peerDependencies": { "@aws-sdk/client-sns": "^3.577.0" diff --git a/sns/package.json b/sns/package.json index 4d27c4d4..77041665 100644 --- a/sns/package.json +++ b/sns/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/sns", "description": "Wing library for interacting with Amazon SNS", - "version": "0.1.5", + "version": "0.1.6", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/tf/API.md b/tf/API.md new file mode 100644 index 00000000..6e8ee98c --- /dev/null +++ b/tf/API.md @@ -0,0 +1,149 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Resource + - Provider + - Element +- **Structs** + - ResourceProps + - ProviderProps + +

Resource (preflight class)

+ +

Constructor

+ +
+new(props: ResourceProps): Resource
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| connection | any? | *No description* | +| count | any? | *No description* | +| dependsOn | Array? | *No description* | +| forEach | ITerraformIterator? | *No description* | +| lifecycle | TerraformResourceLifecycle? | *No description* | +| provider | TerraformProvider? | *No description* | +| provisioners | Array? | *No description* | +| terraformGeneratorMetadata | TerraformProviderGeneratorMetadata? | *No description* | +| terraformMetaArguments | Map | *No description* | +| terraformResourceType | str | *No description* | +| cdktfStack | TerraformStack | *No description* | +| fqn | str | *No description* | +| friendlyUniqueId | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addMoveTarget(moveTarget: str): void | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | +| getAnyMapAttribute(terraformAttribute: str): Map | *No description* | +| getBooleanAttribute(terraformAttribute: str): IResolvable | *No description* | +| getBooleanMapAttribute(terraformAttribute: str): Map | *No description* | +| getListAttribute(terraformAttribute: str): Array | *No description* | +| getNumberAttribute(terraformAttribute: str): num | *No description* | +| getNumberListAttribute(terraformAttribute: str): Array | *No description* | +| getNumberMapAttribute(terraformAttribute: str): Map | *No description* | +| getStringAttribute(terraformAttribute: str): str | *No description* | +| getStringMapAttribute(terraformAttribute: str): Map | *No description* | +| hasResourceMove(): any? | *No description* | +| importFrom(id: str, provider: TerraformProvider?): void | *No description* | +| interpolationForAttribute(terraformAttribute: str): IResolvable | *No description* | +| static isTerraformResource(x: any): bool | *No description* | +| moveFromId(id: str): void | Move the resource corresponding to "id" to this resource. | +| moveTo(moveTarget: str, index: any?): void | Moves this resource to the target resource given by moveTarget. | +| moveToId(id: str): void | Moves this resource to the resource corresponding to "id". | +| toHclTerraform(): any | *No description* | +| toMetadata(): any | *No description* | +| toTerraform(): any | Adds this resource to the terraform JSON output. | +| addOverride(path: str, value: any): void | *No description* | +| static isTerraformElement(x: any): bool | *No description* | +| overrideLogicalId(newLogicalId: str): void | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId(): void | Resets a previously passed logical Id to use the auto-generated logical id again. | + +

Provider (preflight class)

+ +

Constructor

+ +
+new(props: ProviderProps): Provider
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| alias | str? | *No description* | +| fqn | str | *No description* | +| metaAttributes | Map | *No description* | +| terraformGeneratorMetadata | TerraformProviderGeneratorMetadata? | *No description* | +| terraformProviderSource | str? | *No description* | +| terraformResourceType | str | *No description* | +| cdktfStack | TerraformStack | *No description* | +| friendlyUniqueId | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| static isTerraformProvider(x: any): bool | *No description* | +| toHclTerraform(): any | *No description* | +| toMetadata(): any | *No description* | +| toTerraform(): any | Adds this resource to the terraform JSON output. | +| addOverride(path: str, value: any): void | *No description* | +| static isTerraformElement(x: any): bool | *No description* | +| overrideLogicalId(newLogicalId: str): void | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId(): void | Resets a previously passed logical Id to use the auto-generated logical id again. | + +

Element (preflight class)

+ +

Constructor

+ +
+new(config: Json): Element
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| cdktfStack | TerraformStack | *No description* | +| fqn | str | *No description* | +| friendlyUniqueId | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| toTerraform(): Json | *No description* | +| addOverride(path: str, value: any): void | *No description* | +| static isTerraformElement(x: any): bool | *No description* | +| overrideLogicalId(newLogicalId: str): void | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId(): void | Resets a previously passed logical Id to use the auto-generated logical id again. | +| toHclTerraform(): any | *No description* | +| toMetadata(): any | *No description* | + +

ResourceProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attributes | Json? | *No description* | +| type | str | *No description* | + +

ProviderProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attributes | Json? | The provider-specific configuration options. @default {} | +| name | str | The name of the provider in Terraform - this is the prefix used for all resources in the provider. @example "aws" | +| source | str | The source of the provider on the Terraform Registry. @example "hashicorp/aws" | +| version | str | The version of the provider to use. @example "2.0" | + diff --git a/tf/package-lock.json b/tf/package-lock.json index 377ffb8d..41d79b9f 100644 --- a/tf/package-lock.json +++ b/tf/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/tf", - "version": "0.0.7", + "version": "0.0.8", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/tf", - "version": "0.0.7", + "version": "0.0.8", "license": "MIT", "peerDependencies": { "cdktf": "*" diff --git a/tf/package.json b/tf/package.json index ab9153a4..27e24baa 100644 --- a/tf/package.json +++ b/tf/package.json @@ -5,7 +5,7 @@ "email": "eladb@wing.cloud", "name": "Elad Ben-Israel" }, - "version": "0.0.7", + "version": "0.0.8", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git", diff --git a/tsoa/API.md b/tsoa/API.md new file mode 100644 index 00000000..9b6d809d --- /dev/null +++ b/tsoa/API.md @@ -0,0 +1,137 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Service_tfaws + - Service_sim + - Service +- **Interfaces** + - IService +- **Structs** + - LiftOptions + - ServiceProps + - SpecProps + - StartServiceOptions + +

Service_tfaws (preflight class)

+ +

Constructor

+ +
+new(props: ServiceProps): Service_tfaws
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| specFile | str | *No description* | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| lift(client: Resource, ops: LiftOptions): void | *No description* | + +

Service_sim (preflight class)

+ +

Constructor

+ +
+new(props: ServiceProps): Service_sim
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| specFile | str | *No description* | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| lift(client: Resource, ops: LiftOptions): void | *No description* | + +

Service (preflight class)

+ +

Constructor

+ +
+new(props: ServiceProps): Service
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| specFile | str | *No description* | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| lift(client: Resource, ops: LiftOptions): void | *No description* | + +

IService (interface)

+ +

Properties

+ +*No properties* + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| lift(client: Resource, ops: LiftOptions): void | *No description* | + +

LiftOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| allow | Array | *No description* | +| id | str | *No description* | + +

ServiceProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| controllerPathGlobs | Array | *No description* | +| entryFile | str? | *No description* | +| outputDirectory | str | *No description* | +| routesDir | str | *No description* | +| spec | SpecProps? | *No description* | +| watchDir | str? | *No description* | + +

SpecProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| outputDirectory | str? | *No description* | +| specVersion | num? | *No description* | + +

StartServiceOptions (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| basedir | str | *No description* | +| clients | Map | *No description* | +| currentdir | str | *No description* | +| homeEnv | str | *No description* | +| lastPort | str? | *No description* | +| options | ServiceProps | *No description* | +| pathEnv | str | *No description* | +| workdir | str | *No description* | + diff --git a/tsoa/package-lock.json b/tsoa/package-lock.json index f3024e9b..e2bd61cc 100644 --- a/tsoa/package-lock.json +++ b/tsoa/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/tsoa", - "version": "0.1.13", + "version": "0.1.14", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/tsoa", - "version": "0.1.13", + "version": "0.1.14", "license": "MIT", "peerDependencies": { "@cdktf/provider-aws": "^19.13.0", diff --git a/tsoa/package.json b/tsoa/package.json index 51737d25..3bf1a05d 100644 --- a/tsoa/package.json +++ b/tsoa/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/tsoa", "description": "TSOA library for Wing", - "version": "0.1.13", + "version": "0.1.14", "author": { "email": "eyalk@wing.cloud", "name": "Eyal Keren" diff --git a/vite/API.md b/vite/API.md new file mode 100644 index 00000000..9ce8763b --- /dev/null +++ b/vite/API.md @@ -0,0 +1,78 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - Vite + - Vite_tf_aws + - Vite_sim +- **Structs** + - ViteProps + +

Vite (preflight class)

+ +

Constructor

+ +
+new(props: ViteProps): Vite
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +*No methods* + +

Vite_tf_aws (preflight class)

+ +

Constructor

+ +
+new(props: ViteProps): Vite_tf_aws
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +*No methods* + +

Vite_sim (preflight class)

+ +

Constructor

+ +
+new(props: ViteProps): Vite_sim
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +*No methods* + +

ViteProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| generateTypeDefinitions | bool? | *No description* | +| openBrowser | bool? | *No description* | +| publicEnv | Map? | *No description* | +| publicEnvName | str? | *No description* | +| root | str | *No description* | +| typeDefinitionsFilename | str? | *No description* | + diff --git a/vite/package-lock.json b/vite/package-lock.json index bc3808d2..0b1126ba 100644 --- a/vite/package-lock.json +++ b/vite/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/vite", - "version": "0.2.3", + "version": "0.2.4", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/vite", - "version": "0.2.3", + "version": "0.2.4", "license": "MIT", "peerDependencies": { "@cdktf/provider-aws": "^19.12.0", diff --git a/vite/package.json b/vite/package.json index 0ae3e24a..c1f095c6 100644 --- a/vite/package.json +++ b/vite/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/vite", - "version": "0.2.3", + "version": "0.2.4", "description": "Wing resource that allows deploying a Vite application to the cloud", "repository": { "type": "git", diff --git a/websockets/API.md b/websockets/API.md new file mode 100644 index 00000000..8407fe17 --- /dev/null +++ b/websockets/API.md @@ -0,0 +1,183 @@ +

API Reference

+ +

Table of Contents

+ +- **Classes** + - WebSocket + - platform.WebSocket_tfaws + - platform.WebSocket_sim + - platform.WebSocket_awscdk +- **Interfaces** + - platform.aws.IAwsWebSocket + - commons.IWebSocket +- **Structs** + - platform.aws.WebSocketAwsRequest + - platform.aws.WebSocketAwsRequestContext + - platform.aws.WebSocketAwsResponse + - commons.WebSocketProps + +

WebSocket (preflight class)

+ +

Constructor

+ +
+new(props: WebSocketProps): WebSocket
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onConnect(handler: inflight (str): void): void | *No description* | +| onDisconnect(handler: inflight (str): void): void | *No description* | +| onMessage(handler: inflight (str, str): void): void | *No description* | +| inflight sendMessage(connectionId: str, message: str): void | *No description* | + +

platform.WebSocket_tfaws (preflight class)

+ +

Constructor

+ +
+new(props: WebSocketProps): WebSocket_tfaws
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addRoute(handler: Function, routeKey: str): void | *No description* | +| onConnect(handler: inflight (str): void): void | *No description* | +| onDisconnect(handler: inflight (str): void): void | *No description* | +| onMessage(handler: inflight (str, str): void): void | *No description* | +| inflight sendMessage(connectionId: str, message: str): void | *No description* | + +

platform.WebSocket_sim (preflight class)

+ +

Constructor

+ +
+new(props: WebSocketProps): WebSocket_sim
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onConnect(handler: inflight (str): void): void | *No description* | +| onDisconnect(handler: inflight (str): void): void | *No description* | +| onMessage(handler: inflight (str, str): void): void | *No description* | +| inflight sendMessage(connectionId: str, message: str): void | *No description* | + +

platform.WebSocket_awscdk (preflight class)

+ +

Constructor

+ +
+new(props: WebSocketProps): WebSocket_awscdk
+
+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| url | str | *No description* | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addRoute(handler: Function, routeKey: str): void | *No description* | +| onConnect(handler: inflight (str): void): void | *No description* | +| onDisconnect(handler: inflight (str): void): void | *No description* | +| onMessage(handler: inflight (str, str): void): void | *No description* | +| inflight sendMessage(connectionId: str, message: str): void | *No description* | + +

platform.aws.IAwsWebSocket (interface)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | Node | The tree node. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| addRoute(handler: Function, routeKey: str): void | *No description* | +| onConnect(handler: inflight (str): void): void | *No description* | +| onDisconnect(handler: inflight (str): void): void | *No description* | +| onMessage(handler: inflight (str, str): void): void | *No description* | +| inflight sendMessage(connectionId: str, message: str): void | *No description* | + +

commons.IWebSocket (interface)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | Node | The tree node. | + +

Methods

+ +| **Signature** | **Description** | +| --- | --- | +| onConnect(handler: inflight (str): void): void | *No description* | +| onDisconnect(handler: inflight (str): void): void | *No description* | +| onMessage(handler: inflight (str, str): void): void | *No description* | +| inflight sendMessage(connectionId: str, message: str): void | *No description* | + +

platform.aws.WebSocketAwsRequest (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| body | str | *No description* | +| requestContext | WebSocketAwsRequestContext | *No description* | + +

platform.aws.WebSocketAwsRequestContext (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| connectionId | str | *No description* | +| routeKey | str | *No description* | + +

platform.aws.WebSocketAwsResponse (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| body | str? | *No description* | +| statusCode | num | *No description* | + +

commons.WebSocketProps (struct)

+ +

Properties

+ +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | str | *No description* | +| stageName | str? | *No description* | + diff --git a/websockets/package-lock.json b/websockets/package-lock.json index 2758bf6b..df2e671e 100644 --- a/websockets/package-lock.json +++ b/websockets/package-lock.json @@ -1,12 +1,12 @@ { "name": "@winglibs/websockets", - "version": "0.3.11", + "version": "0.3.12", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@winglibs/websockets", - "version": "0.3.11", + "version": "0.3.12", "license": "MIT", "devDependencies": { "@types/ws": "^8.5.10" diff --git a/websockets/package.json b/websockets/package.json index cccdcf17..e6164da8 100644 --- a/websockets/package.json +++ b/websockets/package.json @@ -1,7 +1,7 @@ { "name": "@winglibs/websockets", "description": "WebSocket library for Wing", - "version": "0.3.11", + "version": "0.3.12", "repository": { "type": "git", "url": "https://github.com/winglang/winglibs.git",